# Video Decode 项目本地运行指南

## 环境要求

- Python 3.13+ (当前版本: 3.13.2)
- MySQL 数据库

## 快速开始

### 1. 安装依赖

```bash
pip install -r requirements.txt
```

或者使用国内镜像加速：

```bash
pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple
```

### 2. 配置环境变量

在项目根目录创建 `.env` 文件，配置数据库连接信息：

```env
# 环境配置 (local/dev/prod)
APP_ENV=local

# 数据库配置
DB_HOST=localhost
DB_PORT=3306
DB_USER=your_db_user
DB_PASSWORD=your_db_password
DB_NAME=content-deconstruction-supply-test

# 其他环境变量（根据项目需要添加）
```

**注意：** 如果不配置 `.env` 文件，系统会使用代码中的默认值（生产环境数据库）。

### 3. 启动服务

#### 方式一：使用 uvicorn 直接启动

```bash
uvicorn main:app --host 0.0.0.0 --port 8000 --reload
```

- `--reload`: 开发模式，代码修改后自动重启
- 访问地址: http://localhost:8000
- API 文档: http://localhost:8000/docs

#### 方式二：使用 Python 启动

```bash
python -m uvicorn main:app --host 0.0.0.0 --port 8000 --reload
```

### 4. 验证服务

启动后访问：
- API 文档: http://localhost:8000/docs
- 健康检查: http://localhost:8000/docs (FastAPI 自动生成)

## 主要 API 接口

1. **POST** `/api/v1/content/tasks/decode` - 创建解码任务
2. **GET** `/api/v1/content/tasks/{taskId}` - 获取任务详情
3. **POST** `/api/v1/content/tasks/pattern` - 创建模式任务

## 使用 Docker 运行（可选）

### 构建并启动

```bash
docker-compose up -d
```

### 查看日志

```bash
docker-compose logs -f
```

### 停止服务

```bash
docker-compose down
```

## 常见问题

### 1. 数据库连接失败

- 检查 `.env` 文件中的数据库配置是否正确
- 确认数据库服务是否启动
- 检查网络连接和防火墙设置

### 2. 依赖安装失败

- 使用国内镜像：`pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple`
- 检查 Python 版本是否符合要求（3.13+）

### 3. 端口被占用

- 修改启动命令中的端口号：`--port 8001`
- 或者停止占用 8000 端口的其他服务

## 开发建议

- 开发环境建议使用 `--reload` 参数，方便调试
- 生产环境建议使用 `gunicorn` + `uvicorn` workers 部署
- 定期检查日志输出，使用 `loguru` 进行日志管理