You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
wevsty 4e1eb97056
Split kill_house() fix issues #1234 (#1300)
* Split kill_house() fix issues #1234

Details View issues #1234

* Removing the catch finally

* rename wait_horse() to wait_for_horse()

* rename wait_horse() to wait_for_horse()

* update test_handle_shutdown_request()

Change test_handle_shutdown_request() exitcode assert

* Restore kill_horse() output

* optimization wait_for_horse()
5 years ago
.github Fix scheduler on Python 3.8 (#1302) 5 years ago
docs Add get_job_position and get_position feature (#1271) 5 years ago
examples fix print in example 11 years ago
rq Split kill_house() fix issues #1234 (#1300) 5 years ago
tests Split kill_house() fix issues #1234 (#1300) 5 years ago
.coveragerc Ignore local.py (it's tested in werkzeug instead). 11 years ago
.deepsource.toml Fix some code quality issues (#1235) 5 years ago
.gitignore RQ v1.0! (#1059) 6 years ago
.mailmap Add .mailmap 9 years ago
CHANGES.md Python 2.7 supported dropped in 1.4.0 (CHANGES.md) (#1295) 5 years ago
LICENSE Fix year. 13 years ago
MANIFEST.in Fix some code quality issues (#1235) 5 years ago
Makefile Clean dist+build folders before releasing 10 years ago
README.md Replace travis with GitHub action (#1290) 5 years ago
dev-requirements.txt Job scheduling (#1163) 5 years ago
requirements.txt Improve requirements handling (#1287) 5 years ago
setup.cfg modify zadd calls for redis-py 3.0 (#1016) 6 years ago
setup.py setup: Set min Python version to 3.5 (#1291) 5 years ago
tox.ini Fix run_tests to use pytest. (#1033) 6 years ago

README.md

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.

Build status PyPI Coverage

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:

import requests

def count_words_at_url(url):
    """Just an example function that's called async."""
    resp = requests.get(url)
    return len(resp.text.split())

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

Then, create an RQ queue:

from redis import Redis
from rq import Queue

q = Queue(connection=Redis())

And enqueue the function call:

from my_module import count_words_at_url
job = 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:

$ rq worker
*** 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+https://github.com/nvie/rq.git@master#egg=rq

Check out these below repos which might be useful in your rq based project.

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.