Adds Dramatiq support to your Flask application
Project description
Flask-Dramatiq plugs Dramatiq task queue in your Flask web application.
// Features //
- Configure Dramatiq from Flask configuration.
- Ensure Flask app is available to Dramatiq actor.
- Add
worker
command to Flask CLI. - Enable Flask Application factory.
- Handle multiple brokers with configurable prefix.
Full documentation at flask-dramatiq.readthedocs.io.
// Installation and Usage //
Flask-Dramatiq is licensed under BSD-3-Clause. Add flask-dramatiq
to your
project:
$ poetry add flask-dramatiq
Then use Dramatiq
object as a regular Flask extension:
from flask import Flask
from flask_dramatiq import Dramatiq
app = Flask(__name__)
dramatiq = Dramatiq(app)
@dramatiq.actor()
def my_actor():
...
@app.route("/")
def myhandler():
my_actor.send()
Flask-Dramatiq adds two configuration keys:
DRAMATIQ_BROKER
, points to broker class likedramatiq.brokers.rabbitmq.RabbitmqBroker
ordramatiq.brokers.redis.RedisBroker
.DRAMATIQ_BROKER_URL
is passed asurl
keyword argument to broker class.
Now run worker program to consume messages and execute tasks in the background:
$ flask worker --processes=1
A complete flask app is available in project source tree example.py.
// Credit and Support //
Feel free to open an issue or suggest a merge request on Gitlab project page. Contribution welcome!
The project is based on Bogdanp/flask_dramatiq_example.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flask_dramatiq-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4a345336979bbb0bb82e0ebb71e1d13d63a53ad86e171839c37d8d11d01935d |
|
MD5 | c50474eb349a64d3371245bb50773a19 |
|
BLAKE2b-256 | be3344291ac3c2f39489f987ff003eaf9aab55e52fef3602cf199162802f8f2b |