Simple job queues for Python
Go to file
Alexander Artemenko 530930bc7b Fixed code snippets' styling. 2012-08-02 16:52:12 +04:00
examples Rewrite of the connection setup. 2012-05-21 08:08:59 +02:00
rq Merge hotfix/0.2.2 2012-08-01 14:04:57 +02:00
tests Resolve connections early. 2012-07-24 12:37:59 +02:00
.gitignore Ignore autoenv file. 2012-02-15 13:15:57 +01:00
.travis.yml Add way of running tests unfiltered. 2012-07-18 09:45:18 +02:00
CHANGES.md Fixed code snippets' styling. 2012-08-02 16:52:12 +04:00
LICENSE Fix year. 2012-03-28 10:49:28 +02:00
README.md Add Travis CI configuration file. 2012-07-18 09:32:36 +02:00
requirements.txt Add Travis CI configuration file. 2012-07-18 09:32:36 +02:00
run_tests Add way of running tests unfiltered. 2012-07-18 09:45:18 +02:00
setup.cfg Add RPM dependencies. 2012-01-25 10:46:11 +01:00
setup.py Remove strict procname dependency. 2012-06-03 22:08:50 +02:00

README.md

Build status

RQ (Redis Queue) is a simple Python library for queueing jobs and processing them in the background with workers. It is backed by Redis and it is designed to have a low barrier to entry. It should be integrated in your web stack easily.

Getting started

First, run a Redis server, of course:

$ redis-server

To put jobs on queues, you don't have to do anything special, just define your typically lengthy or blocking function:

import requests

def count_words_at_url(url):
    resp = requests.get(url)
    return len(resp.text.split())

You do use the excellent requests package, don't you?

Then, create a RQ queue:

from rq import Queue, use_connection
use_connection()
q = Queue()

And enqueue the function call:

from my_module import count_words_at_url
result = q.enqueue(count_words_at_url, 'http://nvie.com')

For a more complete example, refer to the docs. But this is the essence.

The worker

To start executing enqueued function calls in the background, start a worker from your project's directory:

$ rqworker
*** Listening for work on default
Got count_words_at_url('http://nvie.com') from default
Job result = 818
*** Listening for work on default

That's about it.

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

Project history

This project has been inspired by the good parts of Celery, Resque and this snippet, and has been created as a lightweight alternative to the heaviness of Celery or other AMQP-based queueing implementations.