# flow

**Repository Path**: yxhpy/flow

## Basic Information

- **Project Name**: flow
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-08
- **Last Updated**: 2026-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 教室借用智能审核系统

基于FastAPI和大模型的教室借用智能审核系统，支持多种文件格式解析和MCP协议。

## 功能特性

- 🚀 **FastAPI框架**: 高性能异步API框架
- 📄 **多格式文件解析**: 支持MD、PDF、Word、Excel、图片等格式
- 🤖 **AI智能审核**: 集成大模型进行智能审核
- 📡 **MCP协议支持**: 符合模型上下文协议标准
- 🔌 **OpenAI兼容API**: 提供OpenAI格式的API接口
- 🐳 **容器化部署**: 支持Docker容器化部署

## 项目结构

```
teach_workflow/
├── src/
│   ├── main.py              # 应用入口
│   ├── models/              # 数据模型
│   ├── routers/             # API路由
│   ├── services/            # 业务服务
│   └── utils/               # 工具函数
├── config/
│   └── settings.py          # 配置文件
├── tests/                   # 测试文件
├── requirements.txt         # 依赖包
├── pyproject.toml          # 项目配置
└── Dockerfile              # Docker配置
```

## 快速开始

### 本地开发

1. 克隆项目
```bash
git clone <repository-url>
cd teach_workflow
```

2. 安装依赖
```bash
pip install -r requirements.txt
```

3. 配置环境变量
```bash
cp .env.example .env
# 编辑 .env 文件，设置API密钥
```

4. 启动开发服务器
```bash
python run.py
```

5. 访问API文档
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc

### Docker部署

1. 构建镜像
```bash
docker build -t teach-workflow .
```

2. 运行容器
```bash
docker run -p 8000:8000 -v $(pwd)/.env:/app/.env teach-workflow
```

## API接口

### 基础接口

- `GET /` - 根路径信息
- `GET /health` - 健康检查
- `GET /api/v1/info` - API信息

### 文件处理

- `POST /api/v1/files/upload` - 上传并解析文件
- `POST /api/v1/files/parse` - 解析指定路径文件
- `GET /api/v1/files/supported-types` - 获取支持的文件类型

### 教室审核

- `POST /api/v1/classroom/apply` - 提交教室借用申请
- `GET /api/v1/classroom/rules` - 获取审核规则
- `POST /api/v1/classroom/rules/validate` - 验证审核规则

## 开发

### 运行测试

```bash
pytest tests/
```

### 代码格式化

```bash
black src/
```

### 类型检查

```bash
mypy src/
```

## 许可证

MIT License