dramatiq-pg

Release 0.4.1

Postgres Broker for Dramatiq Task Queue

Homepage PyPI

Keywords
postgres, task, queue, dramatiq, python, task queue
License
PostgreSQL
Install
pip install dramatiq-pg==0.4.1

Documentation

dramatiq-pg − Postgres Broker for Dramatiq

Dramatiq is a simple task queue implementation for Python3. dramatiq-pg provides a Postgres-based implementation of a dramatiq broker.

Features

  • Super simple deployment: Single table, no ORM.
  • Stores message payload and results as native JSONb.
  • Uses LISTEN/NOTIFY to keep worker sync. No polling.
  • Implements delayed task.
  • Reliable thanks to Postgres MVCC.
  • Self-healing: automatic purge of old messages. Automatic recovery after crash.
  • Utility CLI for maintainance: flush, purge, stats, etc.

Note that dramatiq assumes tasks are idempotent. This broker makes the same assumptions for recovering after a crash.

Installation

  • Install dramatiq-pg package from PyPI: 
    $ pip install dramatiq-pg psycopg2-binary
    Ensure you have either psycopg2 or psycopg2-binary installed.
  • Apply dramatiq_pg/schema.sql file in your database: 
    $ psql -f dramatiq_pg/schema.sql
  • Before importing actors, define global broker with a connection pool: 
    import dramatiq
import psycopg2.pool
from dramatiq_pg import PostgresBroker

dramatiq.set_broker(PostgresBroker(i))

@dramatiq.actor
def myactor():
    ...

Now declare/import actors and manage worker just like any dramatiq setup. An example script is available, tested on CI.

The CLI tool dramatiq-pg allows you to requeue messages, purge old messages and show stats on the queue. See --help for details.

Dramatiq-pg documentation is hosted on GitLab and give you more details on deployment and operation of Postgres as a Dramatiq broker.

Support

If you encounter a bug or miss a feature, please open an issue on GitLab with as much information as possible.

dramatiq_pg is available under the PostgreSQL licence.

Stats

Dependencies
2
Dependent packages
2
Dependent repositories
0
Total releases
15
Latest release
First release
Stars
17
Forks
5
Contributors
0
SourceRank
8

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.11.0
0.10.0
0.9.1
0.9.0
0.8.0
0.7.1
0.7.0
0.6.0
0.5.1
0.5.0
See all 15 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2021-11-19 09:34:00 UTC

Login to resync this project