django-rq 0.3.2

A simple app that provides django integration for RQ (Redis Queue)

Django-RQ

Django integration with RQ, a Redis based Python queuing library. Django-RQ is a simple app that allows you to configure your queues in django’s settings.py and easily use them in your project.

Requirements

• Django

• RQ

Installation

• Install django-rq (or download from PyPI):

  pip install django-rq

• Add django_rq to INSTALLED_APPS in settings.py:

  INSTALLED_APPS = (
      # other apps
      "django_rq",
  )

• Configure your queues in django’s settings.py (syntax based on Django’s database config)

  RQ_QUEUES = {
      'default': {
          'HOST': 'localhost',
          'PORT': 6379,
          'DB': 0,
          'PASSWORD': 'some-password',
      },
      'high': {
          'URL': os.getenv('REDISTOGO_URL', 'redis://localhost:6379'), # If you're on Heroku
          'DB': 0,
      },
      'low': {
          'HOST': 'localhost',
          'PORT': 6379,
          'DB': 0,
      }
  }

• Include django_rq.urls in your urls.py:

  urlpatterns += patterns('',
      (r'^django_rq/', include('django_rq.urls')),
  )

Usage

Putting jobs in the queue

Django-RQ allows you to easily put jobs into any of the queues defined in settings.py. It comes with a few utility functions:

• enqueue - push a job to the default queue:

  import django_rq
  django_rq.enqueue(func, foo, bar=baz)

• get_queue - accepts a single queue name argument (defaults to “default”) and returns an RQ Queue instance for you to queue jobs into:

  import django_rq
  queue = django_rq.get_queue('high')
  queue.enqueue(func, foo, bar=baz)

• get_connection - accepts a single queue name argument (defaults to “default”) and returns a connection to the queue’s Redis server:

  import django_rq
  redis_conn = django_rq.get_connection('high')

• get_worker - accepts optional queue names and returns a new RQ Worker instance for specified queues (or default queue):

  import django_rq
  worker = django_rq.get_worker() # Returns a worker for "default" queue
  worker.run()
  worker = django_rq.get_worker('low', 'high') # Returns a worker for "low" and "high"

@job decorator

To easily turn a callable into an RQ task, you can also use the @job decorator that comes with django_rq:

from django_rq import job

@job
def long_running_func():
    pass
long_running_func.delay() # Enqueue function in "default" queue

@job('high')
def long_running_func():
    pass
long_running_func.delay() # Enqueue function in "high" queue

Running workers

django_rq provides a management command that starts a worker for every queue specified as arguments:

python manage.py rqworker high default low

Support for RQ Scheduler

If you have RQ Scheduler installed, you can also use the get_scheduler function to return a Scheduler instance for queues defined in settings.py’s RQ_QUEUES. For example:

import django_rq
scheduler = django_rq.get_scheduler('default')
job = scheduler.enqueue_at(datetime(2020, 10, 10), func)

Queue statistics

django_rq also provides a very simple dashboard to monitor the status of your queues at /django_rq/.

If you need a more sophisticated monitoring tool for RQ, you could also try rq-dashboard.

Testing tip

For an easier testing process, you can run a worker synchronously this way:

from django.test impor TestCase
from django_rq import get_worker

class MyTest(TestCase):
    def test_something_that_creates_jobs(self):
        ...                      # Stuff that init jobs.
        get_worker().work(burst=True)  # Processes all jobs then stop.
        ...                      # Asserts that the job stuff is done.

Running Tests

To run django_rq’s test suite:

django-admin.py test django_rq --settings=django_rq.tests.settings --pythonpath=.

Changelog

Version 0.3.2

• Simplified @job decorator syntax for enqueuing to “default” queue.

Version 0.3.1

• Queues can now be configured using the URL parameter in settings.py.

Version 0.3.0

• Added support for RQ’s @job decorator

• Added get_worker command

Version 0.2.2

• “PASSWORD” key in RQ_QUEUES will now be used when connecting to Redis.