Skip to content

Commit

Permalink
LICENSE is in markdown not plaintext. Updated README examples and add…
Browse files Browse the repository at this point in the history
…ed cronex link as well (from reddit comments).
  • Loading branch information
ahawker committed Feb 22, 2013
1 parent e2a3922 commit 0905bbd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
File renamed without changes.
15 changes: 9 additions & 6 deletions README.md
@@ -1,13 +1,13 @@
# crython [![Build Status](https://travis-ci.org/ahawker/crython.png)](https://travis-ci.org/ahawker/crython)
crython is a python implementation of [cron](http://en.wikipedia.org/wiki/Cron) which can schedule tasks (functions) from standard cron expressions or python objects.
crython is a lightweight task (function) scheduler using [cron](http://en.wikipedia.org/wiki/Cron) expressions written in python.

### Status
This module is currently under development.

### Usage
Crython supports seven fields (seconds, minutes, hours, day of month, month, weekday, year).

Call a function once a second:
Call a function once a minute:
```python
import crython

Expand Down Expand Up @@ -45,13 +45,14 @@ Call functions with positional and/or keyword arguments:
```python
#Fire every second.
@crython.job(second=0, 10, 20, name='Homer Simpson')
def sum(x, y, name='John Smith'):
def sum(x, y, name):
print "Hello {0}. The sum is {1}".format(name, x+y)
```

Start the global job scheduler:
```python
crython.tab.start()
if __name__ == '__main__':
crython.tab.start()
```

### TODO
Expand All @@ -66,5 +67,7 @@ If you would like to contribute, simply fork the repository, push your changes a
Crython is available under the [MIT license](https://github.com/ahawker/crython/blob/master/license.md).

### See Other
There are other python implementations of cron out there.
See: [pycron](http://www.kalab.com/freeware/pycron/pycron.htm), [python-crontab](http://pypi.python.org/pypi/python-crontab/).
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).

0 comments on commit 0905bbd

Please sign in to comment.