Skip to content

index.md

Latest commit

 

History

History
136 lines (95 loc) · 4.27 KB

index.md

File metadata and controls

136 lines (95 loc) · 4.27 KB

FastAPI Factory Utilities - Documentation Index

Generated: 2026-01-11 | Scan Level: Exhaustive | Mode: Initial Scan

Project Overview

Property Value
Type Python Library (Monolith)
Primary Language Python 3.12+
Architecture Plugin-Based with Clean Architecture
Framework FastAPI

Quick Reference

Technology Version Purpose
FastAPI >= 0.115.13 Web framework
Beanie ^2.0.0 MongoDB ODM
Taskiq ^0.3.5 Task queue (Redis)
AioPika ^9.5.7 RabbitMQ messaging
OpenTelemetry ^1.26.0 Observability
Pydantic ^2.8.2 Data validation
Structlog >= 24.1 Structured logging

Entry Point: src/fastapi_factory_utilities/core/ (main library)

Architecture Pattern: Plugin Architecture + Dependency Injection

Generated Documentation

Core Documentation

Document Description
Project Overview Executive summary, tech stack, architecture overview
Architecture Technical architecture reference with diagrams and implementation details
Architecture Decisions Formal architectural decisions, patterns, and AI agent guidelines
Source Tree Analysis Complete directory structure with annotations
Development Guide Setup, testing, code style, CI/CD

Technical Reference

Document Description
API Contracts (To be generated)
Data Models (To be generated)

Existing Documentation

Document Location Description
README.md Project root Introduction, features, quick start, usage examples
SECURITY.md Project root Security policy and vulnerability reporting

Configuration Files

File Purpose
pyproject.toml Poetry, mypy, ruff, pytest configuration
docker-compose.yml Local development services
.github/workflows/ci.yml CI/CD pipeline

Getting Started

For Users of This Library

  1. Install: pip install fastapi-factory-utilities or poetry add fastapi-factory-utilities
  2. Read: README.md for quick start
  3. Review: Architecture for understanding the design
  4. Check: Example App for usage patterns

For Contributors

  1. Read: Development Guide for setup
  2. Review: Architecture for design principles
  3. Explore: Source Tree for codebase navigation

AI-Assisted Development Tips

When working with this codebase, provide the AI with:

  1. This index file - For overall context
  2. Architecture doc - For design decisions
  3. Relevant source files - From src/fastapi_factory_utilities/core/

Key Patterns to Follow

  • Plugin Extension: Implement PluginAbstract for new plugins
  • Configuration: Extend RootConfig for custom config
  • Repositories: Implement AbstractRepository for data access
  • Exceptions: Extend FastAPIFactoryUtilitiesError with auto-logging
  • Testing: Use in-memory mockers from odm_plugin.mockers and aiohttp.mockers

Common Extension Points

What Where How
New Plugin core/plugins/ Extend PluginAbstract
New Service core/services/ Add new service module
Custom Config Your app Extend RootConfig
New Document Your app Extend BaseDocument
Health Strategy core/services/status/ Implement calculator strategy

Scan Report

Metric Value
Scan Date 2026-01-11
Scan Level Exhaustive
Mode Initial Scan
Repository Type Monolith
Project Type Library
Files Generated 5

State file: project-scan-report.json

Generated by BMAD Document Project Workflow