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.

RQ requires Redis >= 3.0.0.

Full documentation can be found here.

Support RQ

If you find RQ useful, please consider supporting this project via Tidelift.

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:

importrequestsdefcount_words_at_url(url):
"""Just an example function that's called async."""resp=requests.get(url)
returnlen(resp.text.split())

Then, create an RQ queue:

fromredisimportRedisfromrqimportQueuequeue=Queue(connection=Redis())

And enqueue the function call:

frommy_moduleimportcount_words_at_urljob=queue.enqueue(count_words_at_url, 'http://nvie.com')

Scheduling jobs are also similarly easy:

# Schedule job to run at 9:15, October 10thjob=queue.enqueue_at(datetime(2019, 10, 10, 9, 15), say_hello)
# Schedule job to run in 10 secondsjob=queue.enqueue_in(timedelta(seconds=10), say_hello)

Retrying failed jobs is also supported:

fromrqimportRetry# Retry up to 3 times, failed job will be requeued immediatelyqueue.enqueue(say_hello, retry=Retry(max=3))
# Retry up to 3 times, with configurable intervals between retriesqueue.enqueue(say_hello, retry=Retry(max=3, interval=[10, 30, 60]))

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:

$ rq worker --with-scheduler*** Listening for work on defaultGot count_words_at_url('http://nvie.com') from defaultJob 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 git+https://github.com/rq/rq.git@master#egg=rq

Related Projects

If you use RQ, Check out these below repos which might be useful in your rq based project.

• django-rq
• rq-dashboard
• rqmonitor
• Flask-RQ2
• rq-scheduler

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.