Setup Job-Runner


By default the settings in job_runner.settings.env.development are used. These settings should work out-of-the box for local development (using Sqlite as a database back-end). Use the --settings argument of to use different settings.

  1. Make sure you have all requirements installed (the exact package names can vary per distribution, these are for Ubuntu).:

    • python-dev
    • virtualenvwrapper
    • build-essential
    • libmysqlclient-dev
  2. Clone the project:

    $ git clone
  3. Create a Virtualenv (, to make sure all requirements are installed in an isolated environment. This is not required, but it will keep your system clean :)

    $ mkvirtualenv job-runner
  4. Install the Job-Runner (which will fetch all Python requirements as well):

    # OPTION 1: Install package in development mode.  Any changes you make
    # will be reflected immediately without having to do an install again.
    $ python develop
    $ pip install -r test-requirements.txt
    # OPTION 2: Just install (you will have to do a new install if you have
    # changed the code).
    $ python install
  5. Initialize the database and run the migations:

    $ syncdb
    $ migrate
    $ collectstatic
  6. Run runserver. This will start a development server with the default development settings.

  7. Run broadcast_queue. This will start the queue broadcaster.

Project Versions

Previous topic

Welcome to Job-Runner’s documentation!

Next topic

Getting started

This Page