WhisperX-FastAPI 项目启动与配置教程

WhisperX-FastAPI 项目启动与配置教程

whisperX-FastAPI FastAPI service on top of WhisperX 项目地址: https://gitcode.com/gh_mirrors/wh/whisperX-FastAPI

1. 项目目录结构及介绍

WhisperX-FastAPI 项目目录结构如下：

whisperX-FastAPI/
├── .devcontainer/
├── .github/
├── .vscode/
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── docs/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── utils/
├── requirements/
│   ├── dev.txt
│   └── prod.txt
├── tests/
├── docker-compose.yml
├── dockerfile
├── pyproject.toml
├── requirements.txt
├── setup.cfg
├── start.sh
└── README.md

• .devcontainer/: 开发容器配置文件。
• .github/: GitHub 工作流程配置文件。
• .vscode/: Visual Studio Code 项目配置文件。
• app/: 项目主体应用程序目录，包含主要的 Python 代码和子模块。
  • __init__.py: 初始化应用模块。
  • main.py: FastAPI 应用启动文件。
  • docs/: Swagger 文档相关文件。
  • models/: 数据库模型定义。
  • routes/: 路由和视图函数。
  • services/: 业务逻辑处理。
  • utils/: 工具类和辅助函数。
• requirements/: 项目依赖文件，分为开发环境和生产环境。
• tests/: 测试代码目录。
• docker-compose.yml: Docker Compose 配置文件，用于定义和运行多容器 Docker 应用。
• dockerfile: Dockerfile 文件，用于构建项目镜像。
• pyproject.toml: 项目配置文件，包含项目元数据和依赖。
• requirements.txt: 项目依赖列表。
• setup.cfg: 设置项目打包和分发配置。
• start.sh: 启动脚本，用于启动 FastAPI 应用。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py。该文件定义了 FastAPI 应用实例并配置了路由。以下是一个简化的启动文件示例：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

在项目根目录下，你可以使用以下命令启动应用：

uvicorn app.main:app --reload

这将启动一个开发服务器，你可以通过 http://127.0.0.1:8000 访问。

3. 项目的配置文件介绍

项目的配置主要通过 .env 环境变量文件和 app/main.py 中的配置代码进行管理。以下是一些主要的环境变量：

• DEFAULT_LANG: 默认语言设置。
• WHISPER_MODEL: Whisper 模型大小设置。
• LOG_LEVEL: 日志级别设置。
• ENVIRONMENT: 环境设置，区分开发环境和生产环境。
• DEV: 布尔值，表示是否为开发环境。
• FILTER_WARNING: 布尔值，用于启用或禁用特定警告的过滤。

.env 文件的典型内容如下：

DEFAULT_LANG=en
WHISPER_MODEL=base
LOG_LEVEL=DEBUG
ENVIRONMENT=production
DEV=true
FILTER_WARNING=true

在 app/main.py 中，你可以使用 python-dotenv 库来加载这些环境变量：

from fastapi import FastAPI
from dotenv import load_dotenv
import os

load_dotenv()

app = FastAPI()

# 你现在可以使用 os.getenv("变量名") 来获取环境变量的值

确保在运行应用之前创建了 .env 文件并正确设置了所需的环境变量。

whisperX-FastAPI FastAPI service on top of WhisperX 项目地址: https://gitcode.com/gh_mirrors/wh/whisperX-FastAPI