Metadata-Version: 2.1
Name: DocCron
Version: 1.0.0
Summary: Schedule with Docstrings
Home-page: https://github.com/Code-ReaQtor/DocCron
Author: Ronie Martinez
Author-email: ronmarti18@gmail.com
License: MIT
Download-URL: https://github.com/Code-ReaQtor/DocCron/tarball/1.0.0
Description: # DocCron
        
        Schedule with Docstrings
        
        <table>
            <tr>
                <td>License</td>
                <td><img src='https://img.shields.io/pypi/l/DocCron.svg'></td>
                <td>Version</td>
                <td><img src='https://img.shields.io/pypi/v/DocCron.svg'></td>
            </tr>
            <tr>
                <td>Travis CI</td>
                <td><img src='https://travis-ci.org/Code-ReaQtor/DocCron.svg?branch=master'></td>
                <td>Coverage</td>
                <td><img src='https://codecov.io/gh/Code-ReaQtor/DocCron/branch/master/graph/badge.svg'></td>
            </tr>
            <tr>
                <td>AppVeyor</td>
                <td><img src='https://ci.appveyor.com/api/projects/status/ceqj4tmh13r8hc79/branch/master?svg=true'></td>
                <td>Supported versions</td>
                <td><img src='https://img.shields.io/pypi/pyversions/DocCron.svg'></td>
            </tr>
            <tr>
                <td>Wheel</td>
                <td><img src='https://img.shields.io/pypi/wheel/DocCron.svg'></td>
                <td>Implementation</td>
                <td><img src='https://img.shields.io/pypi/implementation/DocCron.svg'></td>
            </tr>
            <tr>
                <td>Status</td>
                <td><img src='https://img.shields.io/pypi/status/DocCron.svg'></td>
                <td>Show your support</td>
                <td><a href='https://saythanks.io/to/Code-ReaQtor'><img src='https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg'></a></td>
            </tr>
        </table>
        
        ## Installation
        
        ```bash
        pip install DocCron
        ```
        
        ## Description
        
        Cron-based scheduler inspired by [doctest](https://en.wikipedia.org/wiki/Doctest)
        
        ## Example
        
        ### Standard/Extended Format
        
        Run `hello()` at every 2nd minute and 3rd minute:
        
        ```python
        import time
        
        
        def hello():
            """
            */2 * * * *
            */3 * * * *
            """
            print(time.strftime('%Y-%m-%d %H:%M:%S'), "hello world")
        
        
        if __name__ == '__main__':
            import doccron
            doccron.run_jobs()
        
        ```
        
        ### Quartz Format
        
        Run `hello()` at every 2nd second and 3rd second:
        
        ```python
        import time
        
        
        def hello():
            """
            */2 * * * * *
            */3 * * * * *
            """
            print(time.strftime('%Y-%m-%d %H:%M:%S'), "hello world")
        
        
        if __name__ == '__main__':
            import doccron
            doccron.run_jobs(quartz=True)
        
        ```
        
        ## Features
        
        - [x] Standard and extended cron formats (see [CRON Expression](https://en.wikipedia.org/wiki/Cron#CRON_expression))
        - [x] [Nonstandard predefined scheduling definitions](https://en.wikipedia.org/wiki/Cron#Nonstandard_predefined_scheduling_definitions)
        - [x] [Non-standard characters](https://en.wikipedia.org/wiki/Cron#Non-standard_characters)
        - [x] [Quartz format](http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/crontrigger.html)
        - [ ] Human readable date/time strings 
        
        ## Open to ideas!
        
        This is just a rough implementation of the concept! There are things that might need attention in the future:
        
        - Mixing cron syntax with docstrings equivalent to what doctest is using (>>>))
        - Timezone-awareness
        
        ## References
        
        - [Cron Format](http://www.nncron.ru/help/EN/working/cron-format.htm)
        - [Wikipedia - Cron](https://en.wikipedia.org/wiki/Cron)
        
        ## Author
        
        - [Ronie Martinez](mailto:ronmarti18@gmail.com)
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/markdown
