Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahawker/crython
Lightweight task scheduler using cron expressions
https://github.com/ahawker/crython
cron python python3 scheduler
Last synced: 6 days ago
JSON representation
Lightweight task scheduler using cron expressions
- Host: GitHub
- URL: https://github.com/ahawker/crython
- Owner: ahawker
- License: other
- Created: 2013-01-31T00:24:22.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2023-09-21T01:02:39.000Z (about 1 year ago)
- Last Synced: 2024-10-12T21:59:19.617Z (about 1 month ago)
- Topics: cron, python, python3, scheduler
- Language: Python
- Homepage:
- Size: 238 KB
- Stars: 202
- Watchers: 13
- Forks: 22
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# crython
[](https://gitter.im/crython/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/ahawker/crython)
[](https://ci.appveyor.com/project/ahawker/crython)
[](https://codecov.io/gh/ahawker/crython)
[](https://codeclimate.com/github/ahawker/crython)
[](https://codeclimate.com/github/ahawker/crython)
[](https://badge.fury.io/py/crython)
[](https://pypi.python.org/pypi/crython)
[](http://waffle.io/ahawker/crython)
crython is a lightweight task (function) scheduler using [cron](http://en.wikipedia.org/wiki/Cron) expressions written in python.
### Status
This module is actively maintained.
### Installation
To install crython from [pip](https://pypi.python.org/pypi/pip):
```bash
$ pip install crython
```
To install crython from source:
```bash
$ git clone [email protected]:ahawker/crython.git
$ python setup.py install
```
### Usage
Crython supports seven fields (seconds, minutes, hours, day of month, month, weekday, year).
Call a function once a minute:
```python
import crython
# Fire once a minute.
@crython.job(second=0)
def foo():
print "... while heavy sack beatings are up a shocking nine hundred percent? - Kent Brockman"
```
Call a function every ten seconds:
```python
# Fire every 10 seconds.
@crython.job(second=range(0, 60, 10))
def foo():
print "I'm a big four-eyed lame-o and I wear the same stupid sweater every day. - Homer's Brain"
```
Call a function with a single cron expression:
```python
# Fire every 10 seconds.
@crython.job(second='*/10')
def foo():
print "Hail to the thee Kamp Krusty... - Kampers"
```
Call a function with a full cron expression:
```python
# Fire once a week.
@crython.job(expr='0 0 0 * * 0 *')
def foo():
print "Back in line, maggot! - Kearny"
```
Call a function with positional and/or keyword arguments:
```python
# Fire every second.
@job('safety gloves', second='*', name='Homer Simpson')
def foo(item, name):
print "Well, I don't need {0}, because I'm {1}. -- Grimey".format(item, name)
```
Call a function using [predefined keywords](https://github.com/ahawker/crython#keywords):
```python
# Fire once a day.
@crython.job(expr='@daily')
def foo():
print "That's where I saw the leprechaun. He tells me to burn things! - Ralph Wiggum"
```
```python
# Fire once immediately after scheduler starts.
@crython.job(expr='@reboot')
def foo():
print "I call the big one bitey. - Homer Simpson"
```
Call a function and run it within a separate thread (default behaviour if `ctx` is not specified):
```python
# Fire once a week.
@crython.job(expr='@weekly', ctx='thread')
def foo():
print "No, no, dig up stupid. - Chief Wiggum"
```
Call a function and run it within a separate process:
```python
# Fire every hour.
@crython.job(expr='@hourly', ctx='multiprocess')
def foo():
print "Eat my shorts. - Bart Simpson"
```
Start the global job scheduler:
```python
if __name__ == '__main__':
crython.start()
crython.join() ## This will block
```
Stop the global job scheduler:
```python
crython.stop()
crython.join(timeout=5000) ## This will block 5s waiting for thread to stop.
```
### Keywords
| Entry | Description | Equivalent To |
| --- | --- | --- |
| @yearly/@annually | Run once a year at midnight in the morning of January 1 | 0 0 0 0 1 1 * |
| @monthly | Run once a month at midnight in the morning of the first of the month | 0 0 0 0 1 * * |
| @weekly | Run once a week at midnight in the morning of Sunday | 0 0 0 0 * 0 * |
| @daily | Run once a day at midnight | 0 0 0 * * * * |
| @hourly | Run once an hour at the beginning of the hour | 0 0 * * * * * |
| @minutely | Run once a minute at the beginning of the minute | 0 * * * * * * |
| @reboot | Run once at startup | @reboot |
### TODO
- Support "L", "W" and "#" specials.
- Determine time delta from now -> next time expression is valid.
### Contributing
If you would like to contribute, simply fork the repository, push your changes and send a pull request.
### License
Crython is available under the [MIT license](https://github.com/ahawker/crython/blob/master/LICENSE.md).
### See Other
There are similar python cron libraries out there.
See:
[pycron](http://www.kalab.com/freeware/pycron/pycron.htm),
[python-crontab](http://pypi.python.org/pypi/python-crontab/),
[cronex](https://github.com/jameseric/cronex).