Skip to main content

A dashboard for Dramatiq (Redis-only!).

Project description

dramatiq_dashboard

A dashboard for dramatiq, specific to its Redis broker (sorry RabbitMQ users!). Very alpha stuff.

It comes in the form of a WSGI middleware, with as few dependencies as possible (dramatiq, jinja2 and redis) so it's super easy to plug into whatever web application you have.

screencast

Installation

pip install dramatiq_dashboard

Quickstart

Run the dashboard on top of an existing WSGI app

# Assuming at some point you instantiate your app.
app = create_wsgi_application()

# Import the library, create the middleware and wrap your app with it.
import dramatiq_dashboard

dashboard_middleware = dramatiq_dashboard.make_wsgi_middleware("/drama")
app = dashboard_middleware(app)

Run your app, visit /drama and you should see the dashboard.

Run the dashboard as a standalone webserver

If you don't want to wrap an existing WSGI app, you can also run the dashboard as a standalone server. Install the WSGI server of your choice (e.g. uWSGi, gunicorn, bjoern, etc), setup the Redis broker, and then start DashboardApp directly.

For example, to serve the dashboard on http://127.0.0.1:8080 using the bjoern WSGI server and a redis server on 17.0.0.1:6379, run the following:

import bjoern
import dramatiq
from dramatiq.brokers.redis import RedisBroker
from dramatiq_dashboard import DashboardApp

broker = RedisBroker(host="127.0.0.1", port=6379)
broker.declare_queue("default")
dramatiq.set_broker(broker)
app = DashboardApp(broker=broker, prefix="")
bjoern.run(app, "127.0.0.1", 8080)

Then visit http://127.0.0.1:8080/ to see the running dashboard.

Note that if you use custom queues in your application, they won't be discovered using this approach. You'll have to either add each one of them manually to your broker or import and pass your application's broker to DashboardApp.

License

dramatiq_dashboard is licensed under the LGPL. Please see COPYING and COPYING.LESSER for licensing details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dramatiq_dashboard-0.3.0.tar.gz (28.0 kB view details)

Uploaded Source

Built Distribution

dramatiq_dashboard-0.3.0-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

Details for the file dramatiq_dashboard-0.3.0.tar.gz.

File metadata

  • Download URL: dramatiq_dashboard-0.3.0.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for dramatiq_dashboard-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f22eee2bdc1323b0c4fa1c15cc3bf9af34755f56b3d01618d6f91c3317801bc0
MD5 a4109b3a48fbb30c37f4f86ee1d5f62e
BLAKE2b-256 a01d451d51c708a74694ec541a2b22fc200e90be55a82f2180160621422f5d16

See more details on using hashes here.

Provenance

File details

Details for the file dramatiq_dashboard-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: dramatiq_dashboard-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for dramatiq_dashboard-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24e3703873270f8d6aab6c4ae6683abb4f7ea4d67771b4579e719ca41364bceb
MD5 a85455747df7cd9ac6fd904ef999501f
BLAKE2b-256 3d6ab7eea69fc01bc21dde9c685ea8b517e96eb4372cb414f230f332e757bf17

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page