Local Rag Omscs

🚀 Bootstrapを使用したPythonのFastAPIサービス

このプロジェクトは、Bootstrapを使用したPythonのFastAPIサービスで、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

🔧 技術詳細

マルチステージDocker構成

本プロジェクトでは、本番環境のイメージサイズを最小化するために、マルチステージビルド戦略を採用しています。

• ベースイメージ：約150MB
• 依存関係をインストールした後のイメージ：約360MB（すべてのPythonパッケージを含む）

テスト用のイメージは約850MBと大きく、主に開発およびテスト環境で使用されます。

📦 プロジェクト構造

.
├── README.md           # プロジェクト説明ファイル
├── requirements.txt   # プロジェクト依存関係
├── pyproject.toml     # プロジェクト設定
└── src/               # ソースコードディレクトリ
    ├── app/           # アプリケーションモジュール
    │   ├── models/    # データベースモデル
    │   ├── routes/    # APIルート
    │   └── services/  # ビジネスロジックサービス
    ├── config/        # 設定ファイル
    └── tests/         # テストケース

以上の内容を参考に、このBootstrapベースのPythonのFastAPIサービスをすぐに使い始めることができます。