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

RQ (Redis Queue) integration for Flask applications
https://github.com/mattupstate/flask-rq

Last synced: 3 months ago
JSON representation

RQ (Redis Queue) integration for Flask applications

• Host: GitHub
• URL: https://github.com/mattupstate/flask-rq
• Owner: mattupstate
• License: mit
• Archived: true
• Created: 2012-07-17T05:19:01.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2022-09-10T21:15:26.000Z (almost 2 years ago)
• Last Synced: 2024-03-03T17:47:54.380Z (4 months ago)
• Language: Python
• Size: 292 KB
• Stars: 208
• Watchers: 6
• Forks: 32
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Lists

• awesome-redis - flask-rq - [rq](https://github.com/nvie/rq) integration for Flask applications (Redis based Job Queues)
• awesome-flask - Flask-RQ - RQ (Redis Queue) integration for Flask applications (Task Queue)
• awesome-flask - Flask-RQ - [RQ](https://python-rq.org/) (Redis Queue) integration. (Third-Party Extensions / Task Queues)
• awesome-flask-cn - Flask-RQ - RQ (Redis Queue) integration for Flask applications (介绍)
• my-awesome-stars - mattupstate/flask-rq - RQ (Redis Queue) integration for Flask applications (Python)
• awesome-flask - Flask-RQ - RQ (Redis Queue) integration for Flask applications (Task Queue)
• jimsghstars - mattupstate/flask-rq - RQ (Redis Queue) integration for Flask applications (Python)
• awesome-flask-cn - Flask-RQ - RQ (Redis Queue) integration for Flask applications (Uncategorized / Uncategorized)
• awesome-flask - Flask-RQ - RQ (Redis Queue) integration for Flask applications (Task Queue)

README

        
Flask-RQ

========

.. image:: https://travis-ci.org/mattupstate/flask-rq.svg?branch=master

    :target: https://travis-ci.org/mattupstate/flask-rq

RQ (Redis Queue) integration for Flask applications

Resources

---------

- `Documentation `_

- `Issue Tracker `_

- `Code `_

- `Development Version

  `_

Installation

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

.. code-block:: bash

    $ pip install flask-rq

Getting started

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

To quickly start using `rq`, simply create an RQ instance:

.. code-block:: python

    from flask import Flask

    from flask.ext.rq import RQ

    app = Flask(__name__)

    RQ(app)

``@job`` decorator

~~~~~~~~~~~~~~~~~~~

Provides a way to quickly set a function as an ``rq`` job:

.. code-block:: python

    from flask.ext.rq import job

    @job

    def process(i):

        #  Long stuff to process

    process.delay(3)

A specific queue name can also be passed as argument:

.. code-block:: python

    @job('low')

    def process(i):

        #  Long stuff to process

    process.delay(2)

``get_queue`` function

~~~~~~~~~~~~~~~~~~~~~~

Returns default queue or specific queue for name given as argument:

.. code-block:: python

    from flask.ext.rq import get_queue

    job = get_queue().enqueue(stuff)  # Creates a job on ``default`` queue

    job = get_queue('low').enqueue(stuff)  # Creates a job on ``low`` queue

``get_worker`` function

~~~~~~~~~~~~~~~~~~~~~~~

Returns a worker for default queue or specific queues for names given as arguments:

.. code-block:: python

    from flask.ext.rq import get_worker

    # Creates a worker that handle jobs in ``default`` queue.

    get_worker().work(True)

    # Creates a worker that handle jobs in both ``default`` and ``low`` queues.

    get_worker('default', 'low').work(True)

    # Note: These queues have to share the same connection

Configuration

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

By default Flask-RQ will connect to the default, locally running

Redis server. One can change the connection settings for the default

server like so:

.. code-block:: python

    app.config['RQ_DEFAULT_HOST'] = 'somewhere.com'

    app.config['RQ_DEFAULT_PORT'] = 6479

    app.config['RQ_DEFAULT_PASSWORD'] = 'password'

    app.config['RQ_DEFAULT_DB'] = 1

Queue connection can also be set using a DSN:

.. code-block:: python

    app.config['RQ_LOW_URL'] = 'redis://localhost:6379/2'