{"id":17918020,"url":"https://github.com/bogdanp/dramatiq_dashboard","last_synced_at":"2025-04-06T05:16:46.398Z","repository":{"id":34986282,"uuid":"193263300","full_name":"Bogdanp/dramatiq_dashboard","owner":"Bogdanp","description":"A dashboard for dramatiq, specific to its Redis broker.","archived":false,"fork":false,"pushed_at":"2022-03-17T05:31:26.000Z","size":2852,"stargazers_count":150,"open_issues_count":8,"forks_count":31,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-30T04:11:10.472Z","etag":null,"topics":["python","redis","task-manager","task-runner","task-scheduler"],"latest_commit_sha":null,"homepage":"https://dramatiq.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bogdanp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-22T17:50:29.000Z","updated_at":"2025-01-08T05:38:58.000Z","dependencies_parsed_at":"2022-07-11T09:17:29.977Z","dependency_job_id":null,"html_url":"https://github.com/Bogdanp/dramatiq_dashboard","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bogdanp%2Fdramatiq_dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bogdanp%2Fdramatiq_dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bogdanp%2Fdramatiq_dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bogdanp%2Fdramatiq_dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bogdanp","download_url":"https://codeload.github.com/Bogdanp/dramatiq_dashboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247436286,"owners_count":20938533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","redis","task-manager","task-runner","task-scheduler"],"created_at":"2024-10-28T20:09:27.564Z","updated_at":"2025-04-06T05:16:46.324Z","avatar_url":"https://github.com/Bogdanp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dramatiq_dashboard\n\nA dashboard for [dramatiq], specific to its Redis broker (sorry\nRabbitMQ users!).  Very alpha stuff.\n\nIt comes in the form of a WSGI middleware, with as few dependencies as\npossible (`dramatiq`, `jinja2` and `redis`) so it's super easy to plug\ninto whatever web application you have.\n\n![screencast](https://media.defn.io/dramatiq-dashboard-screencast.gif)\n\n## Installation\n\n    pip install dramatiq_dashboard\n\n## Quickstart\n\n#### Run the dashboard on top of an existing WSGI app\n\n```python\n# Assuming at some point you instantiate your app.\napp = create_wsgi_application()\n\n# Import the library, create the middleware and wrap your app with it.\nimport dramatiq_dashboard\n\ndashboard_middleware = dramatiq_dashboard.make_wsgi_middleware(\"/drama\")\napp = dashboard_middleware(app)\n```\n\nRun your app, visit `/drama` and you should see the dashboard.\n\n#### Run the dashboard as a standalone webserver\n\nIf you don't want to wrap an existing WSGI app, you can also run the\ndashboard as a standalone server.  Install the WSGI server of your\nchoice (e.g. uWSGi, gunicorn, bjoern, etc), setup the Redis broker,\nand then start `DashboardApp` directly.\n\nFor example, to serve the dashboard on `http://127.0.0.1:8080` using\nthe `bjoern` WSGI server and a redis server on `17.0.0.1:6379`, run\nthe following:\n\n```python\nimport bjoern\nimport dramatiq\nfrom dramatiq.brokers.redis import RedisBroker\nfrom dramatiq_dashboard import DashboardApp\n\nbroker = RedisBroker(host=\"127.0.0.1\", port=6379)\nbroker.declare_queue(\"default\")\ndramatiq.set_broker(broker)\napp = DashboardApp(broker=broker, prefix=\"\")\nbjoern.run(app, \"127.0.0.1\", 8080)\n```\n\nThen visit http://127.0.0.1:8080/ to see the running dashboard.\n\n*Note that if you use custom queues in your application, they won't be\ndiscovered using this approach.  You'll have to either add each one of\nthem manually to your broker or import and pass your application's\nbroker to `DashboardApp`.*\n\n## License\n\ndramatiq_dashboard is licensed under the LGPL.  Please see [COPYING]\nand [COPYING.LESSER] for licensing details.\n\n\n[COPYING.LESSER]: https://github.com/Bogdanp/dramatiq_dashboard/blob/master/COPYING.LESSER\n[COPYING]: https://github.com/Bogdanp/dramatiq_dashboard/blob/master/COPYING\n[dramatiq]: https://dramatiq.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbogdanp%2Fdramatiq_dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbogdanp%2Fdramatiq_dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbogdanp%2Fdramatiq_dashboard/lists"}