Introduction
============
`rq-dashboard` is a general purpose, lightweight,
[Flask](https://flask.palletsprojects.com/)-based web front-end to monitor your
[RQ](http://python-rq.org/) queues, jobs, and workers in realtime.
[](https://travis-ci.org/Parallels/rq-dashboard)
[](https://pypi.python.org/pypi/rq-dashboard)
Maturity notes
--------------
The RQ dashboard is currently being developed and is in beta stage.
Installing with Docker
----------------------
You can also run the dashboard inside of docker:
``` {.console}
$ docker pull eoranged/rq-dashboard
$ docker run -p 9181:9181 eoranged/rq-dashboard
```
and you can then run the image. You can pass additional options using
environment variables with prefix `RQ_DASHBOARD_*`:
- RQ_DASHBOARD_REDIS_URL=redis://<redis:6379>
- RQ_DASHBOARD_USERNAME=rq
- RQ_DASHBOARD_PASSWORD=password
See more info on how to pass environment variables in [Docker documentation](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
Installing from PyPI
--------------------
``` {.console}
$ pip install rq-dashboard
```
Running the dashboard
---------------------
Run the dashboard standalone, like this:
``` {.console}
$ rq-dashboard
* Running on http://127.0.0.1:9181/
...
```
``` {.console}
$ rq-dashboard --help
Usage: rq-dashboard [OPTIONS]
Run the RQ Dashboard Flask server.
All configuration can be set on the command line or through environment
variables of the form RQ_DASHBOARD_*. For example RQ_DASHBOARD_USERNAME.
A subset of the configuration (the configuration parameters used by the
underlying flask blueprint) can also be provided in a Python module
referenced using --config, or with a .cfg file referenced by the
RQ_DASHBOARD_SETTINGS environment variable.
Options:
-b, --bind TEXT IP or hostname on which to bind HTTP server
-p, --port INTEGER Port on which to bind HTTP server
--url-prefix TEXT URL prefix e.g. for use behind a reverse
proxy
--username TEXT HTTP Basic Auth username (not used if not
set)
--password TEXT HTTP Basic Auth password
-c, --config TEXT Configuration file (Python module on search
path)
-u, --redis-url TEXT Redis URL. Can be specified multiple times.
Default: redis://127.0.0.1:6379
--poll-interval, --interval INTEGER
Refresh interval in ms
--extra-path TEXT Append specified directories to sys.path
--debug / --normal Enter DEBUG mode
-v, --verbose Enable verbose logging
--help Show this message and exit.
```
Integrating the dashboard in your Flask app
-------------------------------------------
The dashboard can be integrated in to your own [Flask](http://flask.pocoo.org/) app by accessing the blueprint directly in the normal way, e.g.:
``` {.python}
from flask import Flask
import rq_dashboard
app = Flask(__name__)
app.config.from_object(rq_dashboard.default_settings)
app.register_blueprint(rq_dashboard.blueprint, url_prefix="/rq")
@app.route("/")
def hello():
return "Hello World!"
if __name__ == "__main__":
app.run()
```
If you start the Flask app on the default port, you can access the
dashboard at <http://localhost:5000/rq>. The `cli.py:main` entry point
provides a simple working example.
Running on Heroku
-----------------
Consider using third-party project
[rq-dashboard-on-heroku](https://github.com/metabolize/rq-dashboard-on-heroku),
which installs rq-dashboard from PyPI and wraps in in
[Gunicorn](https://gunicorn.org) for deployment to Heroku.
rq-dashboard-on-heroku is maintained indepdently.
Developing
----------
Develop in a virtualenv and make sure you have all the necessary build
time (and run time) dependencies with
$ pip install -r requirements.txt
Develop in the normal way with
$ python setup.py develop
Stats
-----
- [PyPI stats](https://pypistats.org/packages/rq-dashboard)
- [Github stats](https://github.com/Parallels/rq-dashboard/graphs/traffic)
Raw data
{
"_id": null,
"home_page": "https://github.com/Parallels/rq-dashboard",
"name": "rq-dashboard-fork-flask-2.3.2-compatible",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Vincent Driessen",
"author_email": "vincent@3rdcloud.com",
"download_url": "https://files.pythonhosted.org/packages/9b/e2/8c396de01bd3e225ee22708b8712101e650785e6c944b70a143af23b6120/rq-dashboard-fork-flask-2.3.2-compatible-0.6.2.tar.gz",
"platform": "any",
"description": "Introduction\n============\n\n`rq-dashboard` is a general purpose, lightweight,\n[Flask](https://flask.palletsprojects.com/)-based web front-end to monitor your\n[RQ](http://python-rq.org/) queues, jobs, and workers in realtime.\n\n[](https://travis-ci.org/Parallels/rq-dashboard)\n[](https://pypi.python.org/pypi/rq-dashboard)\n\n\nMaturity notes\n--------------\n\nThe RQ dashboard is currently being developed and is in beta stage.\n\nInstalling with Docker\n----------------------\n\nYou can also run the dashboard inside of docker:\n\n``` {.console}\n$ docker pull eoranged/rq-dashboard\n$ docker run -p 9181:9181 eoranged/rq-dashboard\n```\n\nand you can then run the image. You can pass additional options using\nenvironment variables with prefix `RQ_DASHBOARD_*`:\n\n - RQ_DASHBOARD_REDIS_URL=redis://<redis:6379>\n - RQ_DASHBOARD_USERNAME=rq\n - RQ_DASHBOARD_PASSWORD=password\n\nSee more info on how to pass environment variables in [Docker documentation](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)\n\nInstalling from PyPI\n--------------------\n\n``` {.console}\n$ pip install rq-dashboard\n```\n\nRunning the dashboard\n---------------------\n\nRun the dashboard standalone, like this:\n\n``` {.console}\n$ rq-dashboard\n* Running on http://127.0.0.1:9181/\n...\n```\n\n``` {.console}\n$ rq-dashboard --help\nUsage: rq-dashboard [OPTIONS]\n\n Run the RQ Dashboard Flask server.\n\n All configuration can be set on the command line or through environment\n variables of the form RQ_DASHBOARD_*. For example RQ_DASHBOARD_USERNAME.\n\n A subset of the configuration (the configuration parameters used by the\n underlying flask blueprint) can also be provided in a Python module\n referenced using --config, or with a .cfg file referenced by the\n RQ_DASHBOARD_SETTINGS environment variable.\n\nOptions:\n -b, --bind TEXT IP or hostname on which to bind HTTP server\n -p, --port INTEGER Port on which to bind HTTP server\n --url-prefix TEXT URL prefix e.g. for use behind a reverse\n proxy\n --username TEXT HTTP Basic Auth username (not used if not\n set)\n --password TEXT HTTP Basic Auth password\n -c, --config TEXT Configuration file (Python module on search\n path)\n -u, --redis-url TEXT Redis URL. Can be specified multiple times.\n Default: redis://127.0.0.1:6379\n --poll-interval, --interval INTEGER\n Refresh interval in ms\n --extra-path TEXT Append specified directories to sys.path\n --debug / --normal Enter DEBUG mode\n -v, --verbose Enable verbose logging\n --help Show this message and exit.\n```\n\nIntegrating the dashboard in your Flask app\n-------------------------------------------\n\nThe dashboard can be integrated in to your own [Flask](http://flask.pocoo.org/) app by accessing the blueprint directly in the normal way, e.g.:\n\n``` {.python}\nfrom flask import Flask\nimport rq_dashboard\n\napp = Flask(__name__)\napp.config.from_object(rq_dashboard.default_settings)\napp.register_blueprint(rq_dashboard.blueprint, url_prefix=\"/rq\")\n\n@app.route(\"/\")\ndef hello():\n return \"Hello World!\"\n\nif __name__ == \"__main__\":\n app.run()\n```\n\nIf you start the Flask app on the default port, you can access the\ndashboard at <http://localhost:5000/rq>. The `cli.py:main` entry point\nprovides a simple working example.\n\nRunning on Heroku\n-----------------\n\nConsider using third-party project\n[rq-dashboard-on-heroku](https://github.com/metabolize/rq-dashboard-on-heroku),\nwhich installs rq-dashboard from PyPI and wraps in in\n[Gunicorn](https://gunicorn.org) for deployment to Heroku.\nrq-dashboard-on-heroku is maintained indepdently.\n\nDeveloping\n----------\n\nDevelop in a virtualenv and make sure you have all the necessary build\ntime (and run time) dependencies with\n\n $ pip install -r requirements.txt\n\nDevelop in the normal way with\n\n $ python setup.py develop\n\nStats\n-----\n\n- [PyPI stats](https://pypistats.org/packages/rq-dashboard)\n- [Github stats](https://github.com/Parallels/rq-dashboard/graphs/traffic)\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "rq-dashboard is a general purpose, lightweight, web interface to monitor your RQ queues, jobs, and workers in realtime.",
"version": "0.6.2",
"project_urls": {
"Homepage": "https://github.com/Parallels/rq-dashboard"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b9fd0f8ab7b6eeb7f662efc5b0bf894ca5026accbb2241d039185cd7f464527",
"md5": "d0453cfd9df11a6b1774a59334338841",
"sha256": "b0f3bce1d7863c385007ada05b0bfcd594b49b2f6c39f1a6b4ed236dc7aabc9e"
},
"downloads": -1,
"filename": "rq_dashboard_fork_flask_2.3.2_compatible-0.6.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0453cfd9df11a6b1774a59334338841",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 207546,
"upload_time": "2023-05-02T22:56:04",
"upload_time_iso_8601": "2023-05-02T22:56:04.404217Z",
"url": "https://files.pythonhosted.org/packages/2b/9f/d0f8ab7b6eeb7f662efc5b0bf894ca5026accbb2241d039185cd7f464527/rq_dashboard_fork_flask_2.3.2_compatible-0.6.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9be28c396de01bd3e225ee22708b8712101e650785e6c944b70a143af23b6120",
"md5": "ae20ccd3d90392aa93f45e0a5f6b9a35",
"sha256": "808fadb9352478119792f9d72bafe3eeec025573a8129457303a6b348b49e4c1"
},
"downloads": -1,
"filename": "rq-dashboard-fork-flask-2.3.2-compatible-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "ae20ccd3d90392aa93f45e0a5f6b9a35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 200773,
"upload_time": "2023-05-02T22:56:07",
"upload_time_iso_8601": "2023-05-02T22:56:07.573820Z",
"url": "https://files.pythonhosted.org/packages/9b/e2/8c396de01bd3e225ee22708b8712101e650785e6c944b70a143af23b6120/rq-dashboard-fork-flask-2.3.2-compatible-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-02 22:56:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Parallels",
"github_project": "rq-dashboard",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "rq-dashboard-fork-flask-2.3.2-compatible"
}
JSON
