rq-dashboard-fast is a FastAPI-based dashboard to monitor your Redis-Queue (RQ) Jobs, Queues, and Workers

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for arnestr from gravatar.com arnestr Avatar for Hannes221 from gravatar.com Hannes221

Unverified details

These details have not been verified by PyPI
Meta
  • Author: Hannes221
  • Requires: Python <4.0, >=3.10
Classifiers
Report project as malware

Project description

RQ Dashboard FastAPI 🛠

Redis FastAPI Python

RQ Dashboard FastAPI is a general purpose, lightweight FastAPI-based web frontend to monitor your RQ queues, jobs, and workers in real-time. Goal of this package is to ease integration into FastAPI-Applications and provide a Docker Image for convenience.

Screenshot 2024-02-09 at 18 14 13

Featured in Related Projects Redis Queue Docs

Example Usage

from fastapi import FastAPI
from rq_dashboard_fast import RedisQueueDashboard
import uvicorn

app = FastAPI()
dashboard = RedisQueueDashboard("redis://redis:6379/", "/rq")

app.mount("/rq", dashboard)

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

Access the Dashboard at

http://127.0.0.1:8000/rq

Installing from PyPi

PyPi: rq-dashboard-fast

$ pip install rq-dashboard-fast

Running in Docker

  1. You can run the RQ Dashboard FastAPI as a Docker container with custom Redis URL:
docker run -e REDIS_URL=<your_redis_url> hannes221/rq-dashboard-fast

Access the Dashboard at

http://127.0.0.1:8000/rq

To change change the port, you can specify the following flag:

docker run -e REDIS_URL=<your_redis_url>  -e FASTAPI_PORT=<your_fastapi_port> hannes221/rq-dashboard-fast

Replace <your_fastapi_port> with your desired FastAPI and host port.

  1. You can use Docker Compose by creating a docker-compose.yml file:
version: '3.11'
services:
  dashboard:
    image: hannes221/rq-dashboard-fast
    ports:
      - '8000:8000'
    environment:
      - REDIS_URL=<your_redis_url>

Then run:

docker compose up

Access the Dashboard at

http://127.0.0.1:8000/rq

To change the part update the compose file:

version: '3.11'
services:
  dashboard:
    image: hannes221/rq-dashboard-fast
    ports:
      - '<your_fastapi_port>:<your_fastapi_port>'
    environment:
      - REDIS_URL=<your_redis_url>
      - FASTAPI_PORT=<your_fastapi_port>

Replace <your_fastapi_port> with your desired FastAPI and host port.

Docker Hub: hannes221/rq-dashboard-fast

Github Repository

Github: rq-dashboard-fast

$ pip install rq-dashboard-fast

Planned Features

  • Data from rq-scheduler
  • More data about workers
  • Docker Image
  • Add pagination to jobs page
  • Data Export
  • Statistics Tab
  • Run Standalone (Terminal)

Contributing

If you want to contribute, reach out or create a PR directly.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for arnestr from gravatar.com arnestr Avatar for Hannes221 from gravatar.com Hannes221

Unverified details

These details have not been verified by PyPI
Meta
  • Author: Hannes221
  • Requires: Python <4.0, >=3.10
Classifiers

Release history Release notifications | RSS feed

This version

0.5.12

0.5.11

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.2

0.4.1

0.4.0

0.3.8

0.3.7

0.3.5

0.3.1

0.3.0

0.2.4

0.2.3

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Download files

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

Source Distribution

rq_dashboard_fast-0.5.12.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

rq_dashboard_fast-0.5.12-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file rq_dashboard_fast-0.5.12.tar.gz.

File metadata

  • Download URL: rq_dashboard_fast-0.5.12.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for rq_dashboard_fast-0.5.12.tar.gz
Algorithm Hash digest
SHA256 051456474e4df5e081a6a85ba5ce300f252564adb560ab005b3490698b6b8cc6
MD5 8a59c01fea2cb12e9eaa09144a17d9fe
BLAKE2b-256 b09d589a296974173c039f1d20e6159059f7cb33897b524abd065df567f18a24

See more details on using hashes here.

Provenance

The following attestation bundles were made for rq_dashboard_fast-0.5.12.tar.gz:

Publisher: docker-pypi-publish.yml on Hannes221/rq-dashboard-fast

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rq_dashboard_fast-0.5.12-py3-none-any.whl.

File metadata

File hashes

Hashes for rq_dashboard_fast-0.5.12-py3-none-any.whl
Algorithm Hash digest
SHA256 c49b7c0c65beb78fa8f33fac6962c02116c7b2255e1b69fd7411d3f9cf3b1e64
MD5 b80c6cf61af7d815a18adec33d21c117
BLAKE2b-256 0a88a2759d9d8199cf3f5a2fb503f745fd90d10876243541359e4ed37846d845

See more details on using hashes here.

Provenance

The following attestation bundles were made for rq_dashboard_fast-0.5.12-py3-none-any.whl:

Publisher: docker-pypi-publish.yml on Hannes221/rq-dashboard-fast

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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