https://github.com/Bogdanp/dramatiq_dashboard

A dashboard for dramatiq, specific to its Redis broker.
https://github.com/Bogdanp/dramatiq_dashboard

python redis task-manager task-runner task-scheduler

Last synced: about 1 month ago
JSON representation

A dashboard for dramatiq, specific to its Redis broker.

• Host: GitHub
• URL: https://github.com/Bogdanp/dramatiq_dashboard
• Owner: Bogdanp
• License: lgpl-3.0
• Created: 2019-06-22T17:50:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-17T05:31:26.000Z (over 2 years ago)
• Last Synced: 2024-07-25T23:51:32.617Z (about 2 months ago)
• Topics: python, redis, task-manager, task-runner, task-scheduler
• Language: Python
• Homepage: https://dramatiq.io
• Size: 2.72 MB
• Stars: 144
• Watchers: 8
• Forks: 24
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING

Awesome Lists containing this project

README

        
# 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](https://media.defn.io/dramatiq-dashboard-screencast.gif)

## Installation

    pip install dramatiq_dashboard

## Quickstart

#### Run the dashboard on top of an existing WSGI app

```python

# 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:

```python

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.

[COPYING.LESSER]: https://github.com/Bogdanp/dramatiq_dashboard/blob/master/COPYING.LESSER

[COPYING]: https://github.com/Bogdanp/dramatiq_dashboard/blob/master/COPYING

[dramatiq]: https://dramatiq.io