https://github.com/pallets-eco/flask-dramatiq
Plug Dramatiq task queue in your Flask web application.
https://github.com/pallets-eco/flask-dramatiq
dramatiq flask
Last synced: 6 days ago
JSON representation
Plug Dramatiq task queue in your Flask web application.
- Host: GitHub
- URL: https://github.com/pallets-eco/flask-dramatiq
- Owner: pallets-eco
- License: bsd-3-clause
- Created: 2025-12-17T20:08:57.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-05-28T08:26:37.000Z (about 1 month ago)
- Last Synced: 2026-05-28T09:13:55.114Z (about 1 month ago)
- Topics: dramatiq, flask
- Language: Python
- Homepage:
- Size: 927 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Flask-Dramatiq plugs [Dramatiq](https://dramatiq.io) task queue in your
[Flask](https://flask.pocoo.org) 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](http://flask.pocoo.org/docs/dev/tutorial/factory/).
- Handle multiple brokers with configurable prefix.
- Integrates [periodiq](https://gitlab.com/bersace/periodiq). *Optionnal*.
Full documentation at
[flask-dramatiq.readthedocs.io](https://flask-dramatiq.readthedocs.io).
## // Installation and Usage //
Flask-Dramatiq is licensed under BSD-3-Clause. Add `flask-dramatiq` to your
project:
``` console
$ uv add flask-dramatiq
```
Then use `Dramatiq` object as a regular Flask extension:
``` python
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 like
`dramatiq.brokers.rabbitmq:RabbitmqBroker` or
`dramatiq.brokers.redis:RedisBroker`.
- `DRAMATIQ_BROKER_URL` is passed as `url` keyword argument to broker class.
Now run worker program to consume messages and execute tasks in the background:
``` console
$ flask worker --processes=1
```
A complete flask app is available in project source tree
[example.py](https://github.com/pallets-eco/flask-dramatiq/blob/main/example.py).
## // Credit and Support //
Feel free to open an issue or suggest a merge request on [Github project
page](https://github.com/pallets-eco/flask-dramatiq). Contribution welcome!
The project is based on
[Bogdanp/flask_dramatiq_example](https://github.com/Bogdanp/flask_dramatiq_example).