Local Rag Omscs

🚀 Python FastAPI Service with Bootstrap

This project is a Python FastAPI service using Bootstrap, adhering to Clean Architecture and SOLID principles.

🚀 Quick Start

Create the Project Repository

1. Clone the code repository: git clone https://github.com/febus982/bootstrap-python-fastapi.git
2. Navigate to the project directory: cd bootstrap-python-fastapi

Install Dependencies

• Docker Environment:

  docker compose run --rm install-dependencies
  

• Local Development:

  make install-dependencies
  

Start the Application Service

• Start the HTTP Service: make dev-http
• Start the WebSocket Service: make dev-socketio
• Run the Test Suite: make test

✨ Features

• Synchronous and Asynchronous API Documentation: Build RESTful APIs using FastAPI.
• Task Execution Framework: Handle asynchronous tasks with Celery.
• Database Migration Tool: Manage database version control through Alembic.
• Real-time Communication Protocol: Support the Socket.IO implementation of WebSocket.

📚 Documentation

• Online Documentation: docs/index.html
• Generate Offline Documentation: Use make docs to generate.

📦 Project Structure

.
├── README.md           # Project description file
├── requirements.txt   # Project dependencies
├── pyproject.toml     # Project configuration
└── src/               # Source code directory
    ├── app/           # Application module
    │   ├── models/    # Database models
    │   ├── routes/    # API routes
    │   └── services/  # Business logic services
    ├── config/        # Configuration files
    └── tests/         # Test cases

💻 Advanced Usage

Database Migration

• Execute Migration: docker compose run --rm migrate
• Generate a New Migration File: docker compose run --rm autogenerate-migration

Task Queue

• Start the Celery Worker Process: docker compose up dramatiq-worker

Continuous Integration and Development

• Run All Checks: make check
• Automatically Fix Code Issues: make fix

🔧 Multi-stage Docker Configuration

To minimize the size of the production image, a multi-stage build strategy is adopted:

• Base Image: Approximately 150MB
• Image after Installing Dependencies: Approximately 360MB (including all Python packages)

The test image is larger, approximately 850MB, and is mainly used for development and testing environments.

With the above content, you can quickly get started and use this Python FastAPI service based on Bootstrap.