Metadata-Version: 1.1
Name: collective.schedule
Version: 0.2
Summary: Plone integration for the python 'schedule' library
Home-page: https://github.com/netsight/collective.schedule
Author: Matt Sital-Singh
Author-email: UNKNOWN
License: BSD
Description: collective.schedule
        ===================
        
        This package integrates the python 'schedule' library (https://github.com/dbader/schedule) with Plone.
        
        It provides the following:
        
         * A ZML interface for scheduling jobs
         * A single 'tick' job processing view that can be registered using a Zope Clock Server
        
        Configuration
        -------------
        
        First add `collective.schedule` to your buildout eggs.
        Then register the collective.schedule 'tick' method as a clock server in your buildout config:
        
            [buildout]
            ...
        
            [instance]
            recipe = plone.recipe.zope2instance
            ...
            zope-conf-additional =
                <clock-server>
                  method /plonesitename/@@schedule-tick
                  # If you have virtual host rewriting, you will need to
                  # use the following format instead:
                  # method /VirtualHostBase/http/www.mysite.com/plonesitename/VirtualHostRoot/@@schedule-tick
                  period 300
                  user username
                  password password
                </clock-server>
        
        Scheduling jobs
        ---------------
        
        You can then register jobs using ZCML as follows:
        
            <configure
                xmlns:schedule="http://namespaces.zope.org/schedule">
        
                <include package="collective.schedule" />
        
                <schedule:job
                  view="@@some-regular-job"
                  unit="day"
                  at="22:00"
                  />
        
            </configure>
        
        Where 'view' is the *name* of a browser view that can be looked up on the Plone Site and executed with the user defined in the clock server above.
        
        For more details on the options for scheduling jobs, see https://github.com/dbader/schedule
        
        Contributors
        ============
        
        - Matt Sital-Singh (mattss), Original Author
        
        Changelog
        =========
        
        0.2 (2015-03-23)
        ----------------
        - Better error handling and logging. 
          Exceptions in jobs no longer affect other jobs.
          [mattss]
        
        0.1.4 (2013-10-02)
        -------------------
        - Package distribution fixes
          [mattss]
        
        0.1.3 (2013-09-20)
        -------------------
        - Documentation updates
          [mattss]
        
        0.1.2 (2013-09-20)
        -------------------
        - Look up the context (plone site) correctly
          [mattss]
        
        0.1.1 (2013-09-20)
        -------------------
        - Correctly wrap the context in with a request (Fixes AttributeError 'REQUEST' in page templates)
          [mattss]
        
        0.1 (2013-06-14)
        -------------------
        
        - Initial release
          [mattss]
        
        
Keywords: python plone schedule cron
Platform: UNKNOWN
Classifier: Programming Language :: Python
