nvie/rq

 nvie / rq

nvie / rq

Simple job queues for Python http://python-rq.org

rq3826382638283828383038303832383238343834383638363838383838403840384238423844384438463846384838483850385038523852385438542017-05-132017-05-142017-05-152017-05-162017-05-172017-05-182017-05-192017-05-202017-05-212017-05-222017-05-232017-05-242017-05-252017-05-26rq38268.34650851448199.5502444582017-05-13382640.4484643394199.5502444582017-05-14382772.5504201643192.5632019312017-05-153831104.652375989164.615031822017-05-163833136.754331814150.6409467642017-05-173836168.856287639129.6798191812017-05-183837200.958243464122.6927766532017-05-193839233.060199289108.7186915972017-05-203841265.16215511494.74460654182017-05-213844297.26411093973.78347895852017-05-223846329.36606676459.8093939032017-05-233849361.46802258938.84826631962017-05-243853393.56997841310.90009620852017-05-253854425.6719342383.913053680782017-05-26star

 README

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 >= 2.7.0.

Build status Downloads Can I Use Python 3? Coverage Status

Full documentation can be found here.

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
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:

$ 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

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.