Local Rag Omscs

🚀 使用 Bootstrap 的 Python 快速 API 服務

這是一個使用 Bootstrap 的 Python 快速 API 服務，遵循 Clean Architecture 和 SOLID 原則，能幫助開發者快速搭建 RESTful API 並處理異步任務等。

✨ 主要特性

• 同步和異步 API 文檔：使用 FastAPI 搭建 RESTful API。
• 任務執行框架：利用 Celery 處理異步任務。
• 數據庫遷移工具：通過 Alembic 管理數據庫版本控制。
• 即時通信協議：支持 WebSocket 的 Socket.IO 實現。

📚 詳細文檔

• 在線文檔：docs/index.html
• 離線生成文檔：使用 make docs 生成

📦 安裝指南

創建項目倉庫

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

數據庫遷移

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

任務隊列

• 啟動 Celery 工作進程：docker compose up dramatiq-worker

持續集成與開發

• 運行所有檢查：make check
• 自動修復代碼問題：make fix

🔧 技術細節

項目結構

.
├── README.md           # 項目說明文件
├── requirements.txt   # 項目依賴
├── pyproject.toml     # 項目配置
└── src/               # 源代碼目錄
    ├── app/           # 應用模塊
    │   ├── models/    # 數據庫模型
    │   ├── routes/    # API 路由
    │   └── services/  # 業務邏輯服務
    ├── config/        # 配置文件
    └── tests/         # 測試用例

多階段 Docker 配置說明

為了最小化生產鏡像的體積，採用了多階段構建策略：

• 基礎鏡像：約 150MB
• 安裝依賴後的鏡像：約 360MB（含所有 Python 包）

測試鏡像則較大，約為 850MB，主要用於開發和測試環境。

通過以上內容，您可以快速上手並開始使用這個基於 Bootstrap 的 Python 快速 API 服務。