Single Source of Truth – Generating ORM, REST, GQL, MCP and Tests from Pydantic

This documentation is best viewed using Obsidian with the custom plugin included in this repository. The plugin automatically hides folders without documentation, providing a clean, focused view of all available documentation.

Setup:

1. Install Obsidian
2. Open this repository as an Obsidian vault
3. The custom plugin (hide-folders-without-md) will automatically activate
4. Navigate through the documentation using Obsidian's graph view and linked references

Documentation can also be viewed directly in your text editor or GitHub, though you won't benefit from the cross-referencing and visualization features that Obsidian provides.

• src/Framework.md - Comprehensive framework architecture overview
• src/Framework.Test.md - Testing philosophy and patterns

• src/lib/LIB.Overview.md - Library components overview and integration
• src/lib/LIB.Environment.md - Configuration and environment management
• src/lib/LIB.Dependencies.md - System, Python, and extension dependency management
• src/lib/LIB.Pydantic.md - Model utilities and registry management
• src/lib/LIB.Pydantic2FastAPI.md - Automatic FastAPI router generation
• src/lib/LIB.Logging.md - Centralized logging system

• src/database/DB.Management.md - Database management and configuration
• src/database/DB.Patterns.md - Database design patterns and mixins
• src/database/DB.Permissions.md - Permission system architecture
• src/database/DB.Seeding.md - Data seeding and initialization
• src/database/DB.Test.md - Database testing patterns

• src/logic/BLL.Patterns.md - Business logic patterns and best practices
• src/logic/BLL.Abstraction.md - Abstract BLL manager functionality
• src/logic/BLL.Authentication.md - Authentication system implementation
• src/logic/BLL.Hooks.md - Hook system architecture and usage
• src/logic/BLL.Schema.md - Pydantic schema patterns
• src/logic/BLL.Test.md - Business logic testing patterns
• src/logic/SVC.Patterns.md - Background service patterns
• src/logic/SVC.Test.md - Service testing patterns

• src/endpoints/EP.Patterns.md - API endpoint patterns and usage
• src/endpoints/EP.Abstraction.md - Abstract endpoint router
• src/endpoints/EP.ExampleFactory.md - Automatic example generation
• src/endpoints/EP.GQL.md - GraphQL integration
• src/endpoints/EP.Schema.md - API schema patterns
• src/endpoints/EP.Test.md - Endpoint testing patterns

• src/extensions/EXT.md - Extension system architecture
• src/extensions/PRV.md - Provider rotation system

• src/database/migrations/DB.Migrations.md - Database migration patterns

• Python 3.10+

This framework's documentation follows these principles:

1. Architectural Focus: Documentation describes the "why" and "how" of components, not just the "what"
2. Minimal Code Snippets: Code examples are minimal; the documentation focuses on patterns and concepts
3. Cross-Referenced: Heavy use of links between related documentation
4. Layer Separation: Documentation organized by architectural layer
5. Pattern-Based: Emphasis on reusable patterns over specific implementations

When adding new documentation:

1. Follow the existing naming convention: LAYER.Component.md
2. Focus on architectural decisions and patterns
3. Link to related documentation using relative paths
4. Keep code snippets minimal and focused
5. Include "Best Practices" sections where appropriate

This framework provides:

• Pydantic-First Design: Single source of truth for all schemas
• Zero Boilerplate: Automatic generation of database models, endpoints, and documentation
• True Testing: No mocks, real implementations with proper isolation
• Extension Architecture: Modular plugin system with isolated migrations
• Type Safety: End-to-end type checking from API to database

For a comprehensive overview, start with Framework.md.