Local Rag Omscs

🚀 使用 Bootstrap 的 Python 快速 API 服务

这是一个使用 Bootstrap 的 Python 快速 API 服务，遵循 Clean Architecture 和 SOLID 原则，能帮助开发者快速搭建起功能丰富的 API 服务。

🚀 快速开始

创建项目仓库

1. 克隆代码库：

git clone https://github.com/febus982/bootstrap-python-fastapi.git

2. 进入项目目录：

cd bootstrap-python-fastapi

安装依赖项

• Docker 环境：

docker compose run --rm install-dependencies

• 本地开发：

make install-dependencies

启动应用服务

• 启动 HTTP 服务：make dev-http
• 启动 WebSocket 服务：make dev-socketio
• 运行测试套件：make test

✨ 主要特性

• 同步和异步 API 文档：使用 FastAPI 搭建 RESTful API。
• 任务执行框架：利用 Celery 处理异步任务。
• 数据库迁移工具：通过 Alembic 管理数据库版本控制。
• 实时通信协议：支持 WebSocket 的 Socket.IO 实现。

📚 详细文档

• 在线文档：docs/index.html
• 离线生成文档：使用 make docs 生成

🔧 技术细节

项目结构

.
├── README.md           # 项目说明文件
├── requirements.txt   # 项目依赖
├── pyproject.toml     # 项目配置
└── src/               # 源代码目录
├── app/           # 应用模块
│   ├── models/    # 数据库模型
│   ├── routes/    # API 路由
│   └── services/  # 业务逻辑服务
├── config/        # 配置文件
└── tests/         # 测试用例

进阶使用说明

数据库迁移

• 执行迁移：docker compose run --rm migrate
• 生成新迁移文件：docker compose run --rm autogenerate-migration

任务队列

• 启动 Celery 工作进程：docker compose up dramatiq-worker

持续集成与开发

• 运行所有检查：make check
• 自动修复代码问题：make fix

多阶段 Docker 配置说明

为了最小化生产镜像的体积，采用了多阶段构建策略：

• 基础镜像：约 150MB
• 安装依赖后的镜像：约 360MB（含所有 Python 包）

测试镜像则较大，约为 850MB，主要用于开发和测试环境。

通过以上内容，您可以快速上手并开始使用这个基于 Bootstrap 的 Python 快速 API 服务。