Installing chronograph is pretty simple. First add it into INSTALLED_APPS in your file.


As of version 0.3.1, chronograph is only compatible with Django versions >= 1.1.

After this run syncdb. The only thing left to do is set up a periodic call to run the jobs.

If you’re using cron, the following example can be added to your crontab:

* * * * * /path/to/your/project/ cron

You’re done! Every minute cron will check to see if you have any pending jobs and if you do they’ll be run. No more mucking about with your crontab.

If you have a more complicated setup where might not work by default see the section below on installing chronograph in a virtual environment.

New in version 0.2.0: Added chronograph script

If your project does not reside within your global python path then the above crontab snippet won’t work. Instead, django-chronograph now comes with a script called chronograph (located at bin/chronograph) that provides an easy way to run all jobs that are due, like so:

/path/to/bin/chronograph -p /path/to/your/project

For use in a virtual environment, see below.

Within a Virtual Environment

New in version 0.2.0: Added chronograph script

When running a script named chronograph should get installed into your bin directory. This script is meant to make it really easy to call your django-chronograph jobs. For extended usage information, see the output from the script. Here is an example of how to use this script from within the system’s crontab:

* * * * * /path/to/bin/chronograph -e /path/to/ve/bin/ -p /path/to/your/project


This script is new and should be considered experimental. Please report any bugs to the issue tracker.

Deprecated since version 0.2.0: has been removed. Use chronograph instead (see above).

If you’re using a virtual environment, setting up chronograph `` involves a bit more work, but not by much.  Included is a script called `` Copy this file to your project directory.

You should open up this script and modify the path to your virtual environment’s activate script:


Make sure that this file is executable and then update your crontab to execute the script. Running crontab -e:

* * * * * /path/to/your/project/ /path/to/your/project

Make sure that you pass /path/to/your/project to the script as the first argument. This will ensure that cron will not have any problems finding your project directory.

Using Chronograph

If you’ve completed the above steps, you’re all done. Now you can add some jobs to the system. Remember, chronograph is designed to run any installed django-admin management command and it accommodates command-line arguments as well.

Cleaning Out Old Job Logs

If you’d like an easy way to delete old job logs, there is a management command that will do it for you: cron_clean. You can use it like so:

python cron_clean [weeks|days|hours|minutes] [integer]

So, if you want to remove all jobs that are older than a week, you can do the following:

python cron_clean weeks 1

Since this is just a simple management command, you can also easily add it to chronograph, via the admin, so that it will clear out old logs automatically.

Other Useful Bits

There is anther included management command, cronserver which can be used to test the periodic running of jobs. It’ll print out information to the screen about which job are due and also run them. Here is how you would use it:

python cronserver

This will start up a process that will check for and run any jobs that are due every 60 seconds. The interval can be changed by simply passing the number of seconds in between runs. For example, to make the process check for due jobs every 2 minutes, you would run:

python cronserver 120