A Flask extension for RQ.

  • Users starred: 134
  • Users forked: 33
  • Users watching: 4
  • Updated at: 2019-01-03 23:40:24


Documentation Status Test Status Test Coverage Status CalVer - Timely Software Versioning


A Flask extension for RQ (Redis Queue).

This is a continuation of Flask-RQ more in spirit than in code. Many thanks to Matt Wright for the inspiration and providing the shoulders to stand on.


pip install Flask-RQ2

Getting started

To quickly start using Flask-RQ2, simply create an RQ instance:

from flask import Flask
from flask_rq2 import RQ

app = Flask(__name__)
rq = RQ(app)

Alternatively, if you're using the application factory pattern:

from flask_rq2 import RQ
rq = RQ()

and then later call init_app where you create your application object:

from flask import Flask

def create_app():
    app = Flask(__name__)

    from yourapplication.jobs import rq

    # more here..
    return app

For more information see the full documentation on Read The Docs.