RQ Dashboard FastAPI 使用教程

1. 项目目录结构及介绍

RQ Dashboard FastAPI 的项目目录结构如下所示：

rq-dashboard-fast/
├── .gitignore
├── Dockerfile
├── LICENSE.md
├── README.md
├── app.py
├── docker-compose.yml
├── pyproject.toml
├── .github/
│   └── workflows/
│       └── Remove pandas as dependency.yml
└── rq_dashboard_fast/
    ├── __init__.py
    ├── dashboard.py
    ├── jobs.py
    ├── models.py
    ├── queues.py
    ├── templates/
    │   ├── base.html
    │   ├── index.html
    │   ├── job.html
    │   └── queue.html
    └── workers.py

• app.py：FastAPI 应用启动文件。
• docker-compose.yml：Docker Compose 配置文件，用于定义服务。
• Dockerfile：用于构建 Docker 容器的文件。
• LICENSE.md：项目许可证文件，本项目采用 MIT 许可。
• README.md：项目自述文件，介绍了项目的基本信息。
• pyproject.toml：Python 项目配置文件。
• .gitignore：Git 忽略文件，指定 Git 应该忽略的文件和目录。
• .github/workflows/：GitHub Actions 工作流文件，用于自动化项目管理任务。
• rq_dashboard_fast/：包含项目主要代码的目录。

2. 项目的启动文件介绍

项目的启动文件为 app.py，以下是启动文件的基本内容：

from fastapi import FastAPI
from rq_dashboard_fast import RedisQueueDashboard

app = FastAPI()

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

app.mount("/rq", dashboard)

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

在这段代码中，首先从 fastapi 模块导入 FastAPI 类，然后从 rq_dashboard_fast 模块导入 RedisQueueDashboard 类。接着，创建一个 FastAPI 实例和一个 RedisQueueDashboard 实例，并使用 mount 方法将仪表板挂载到 /rq 路由上。最后，如果这个脚本作为主程序运行，它会使用 uvicorn ASGI 服务器来运行应用。

3. 项目的配置文件介绍

项目的配置主要通过 pyproject.toml 文件进行，以下是配置文件的基本内容：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = find:
python_requires = ">= 3.7"

这个配置文件指定了项目构建系统所需的依赖，以及一些项目元数据。python_requires 指定了项目支持的 Python 版本。

项目的 Docker 配置通过 Dockerfile 文件进行，以下是 Dockerfile 的基本内容：

FROM python:3.9-slim

WORKDIR /app

COPY . .

RUN pip install --no-cache-dir -r requirements.txt

CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "8000"]

这个 Dockerfile 使用了 Python 3.9 的 slim 镜像作为基础镜像，设置了工作目录，并复制了项目文件。然后它安装了项目依赖，并设置了容器启动时运行的命令。

以上是 RQ Dashboard FastAPI 的基本使用教程，介绍了项目目录结构、启动文件和配置文件。按照这些指导，用户可以快速搭建和运行 RQ Dashboard FastAPI 项目。