Simple job queues for Python
Go to file
Vincent Driessen fc5097ce7a Better test naming. 2011-11-15 09:36:32 +01:00
examples Adapt examples so they run again. 2011-11-15 00:35:18 +01:00
rq Add dequeue method to Queue. 2011-11-15 09:36:29 +01:00
tests Better test naming. 2011-11-15 09:36:32 +01:00
.gitignore Add some project meta stuff. 2011-11-14 12:11:58 +01:00
README.md Update header style. 2011-11-15 00:38:13 +01:00
run_tests Add some project meta stuff. 2011-11-14 12:11:58 +01:00
setup.py Make it an actual PyPI-managable Python package. 2011-11-14 12:16:28 +01:00

README.md

WARNING: DON'T USE THIS IN PRODUCTION (yet)

rq — Simple job queues for Python

rq is a lightweight Python job queue, based on Redis.

Putting jobs on queues

To put jobs on queues, first declare a Python function call as a job, like so:

@job('default')
def slow_fib(n):
    if n <= 1:
        return 1
    else:
        return slow_fib(n-1) + slow_fib(n-2)

You can still call the function synchronously:

from fib import slow_fib
slow_fib(4)

You can find an example implementation in the examples/ directory. To run it, open two terminal windows and run the following commands in them:

  1. python example/run_worker.py
  2. python example/run_example.py

This starts two workers and starts crunching the fibonacci calculations in the background, while the script shows the crunched data updates every second.

Installation

Simply use the following command to install the latest released version:

pip install rq

If you want the cutting edge version (that may well be broken), use this:

pip install -e git+git@github.com:nvie/rq.git@master#egg=rq