Skip to content

Commit

Permalink
documentation was out of date
Browse files Browse the repository at this point in the history
  • Loading branch information
laat committed Sep 17, 2014
1 parent ca89214 commit 0841712
Showing 1 changed file with 5 additions and 17 deletions.
22 changes: 5 additions & 17 deletions apps/mommy/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,15 @@ Mommy-scheduler

This is a very simple wrapper for [APSchduler](http://pythonhosted.org/APScheduler/) for Django.

## configuration:
None. More from APwrapper could be added, surely.
## Running Sheduler

## Setup:
Add `mommy` to installed apps and add this to the global `urls.py`:

```python
import mommy
`python manage.py mommy`

mommy.autodiscover()
mommy.run()
```
## configuration:

the code above will automatically discover all apps with mommy.py and add them
to the schedule, then run the scheduler.
None. More from APwrapper could be added, surely.

## Setup:
An example of a mommy.py file, defining a task that gets run every 5 seconds:

```python
Expand Down Expand Up @@ -72,8 +65,3 @@ LOGGING = {
}
}
```

## Limitations:
For the scheduler to start running, one must load urls.py.
This is done my doing a simple pageload somewhere in your application, and you
only need to do it *once*

0 comments on commit 0841712

Please sign in to comment.