https://github.com/rq/flask-rq2

A Flask extension for RQ.
https://github.com/rq/flask-rq2

jobs periodic periodic-jobs python queue redis rq scheduler tasks

Last synced: 1 day ago
JSON representation

A Flask extension for RQ.

• Host: GitHub
• URL: https://github.com/rq/flask-rq2
• Owner: rq
• License: mit
• Created: 2016-05-18T20:23:15.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T14:31:07.000Z (about 2 months ago)
• Last Synced: 2024-10-29T17:44:14.134Z (about 2 months ago)
• Topics: jobs, periodic, periodic-jobs, python, queue, redis, rq, scheduler, tasks
• Language: Python
• Homepage: https://flask-rq2.readthedocs.io/
• Size: 147 KB
• Stars: 231
• Watchers: 4
• Forks: 48
• Open Issues: 33
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
Flask-RQ2

=========

.. image:: https://readthedocs.org/projects/flask-rq2/badge/?version=latest

   :target: https://flask-rq2.readthedocs.io/en/latest/?badge=latest

   :alt: Documentation Status

.. image:: https://travis-ci.org/rq/Flask-RQ2.svg?branch=master

   :target: https://travis-ci.org/rq/Flask-RQ2

   :alt: Test Status

.. image:: https://codecov.io/gh/rq/Flask-RQ2/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/rq/Flask-RQ2

   :alt: Test Coverage Status

.. image:: https://img.shields.io/badge/calver-YY.MINOR.MICRO-22bfda.svg

   :target: https://calver.org/

   :alt: CalVer - Timely Software Versioning

Resources

---------

- `Documentation `_

- `Issue Tracker `_

- `Code `_

- `Continuous Integration `_

.. snip

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.

.. _`RQ`: http://python-rq.org/

.. _`Flask-RQ`: https://github.com/mattupstate/flask-rq

.. _`Matt Wright`: https://github.com/mattupstate

Installation

------------

.. code-block:: console

    pip install Flask-RQ2

Getting started

---------------

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

.. code-block:: python

    from flask import Flask

    from flask_rq2 import RQ

    app = Flask(__name__)

    rq = RQ(app)

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

.. code-block:: python

    from flask_rq2 import RQ

    rq = RQ()

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

.. code-block:: python

    from flask import Flask

    def create_app():

        app = Flask(__name__)

        from yourapplication.jobs import rq

        rq.init_app(app)

        # more here..

        return app

.. _`application factory`: http://flask.pocoo.org/docs/0.10/patterns/appfactories/

.. snap

For more information see the `full documentation

`_  on Read The Docs.