This project provides a comprehensive template for building asynchronous web applications using FastAPI, Pydantic 2.0, Alembic, and async SQLModel. It targets developers seeking a robust starting point for modern Python APIs, offering integrated authentication, role-based access control, and asynchronous task management with Celery.

How It Works

The template leverages FastAPI for its high performance and ease of use, combined with SQLModel for asynchronous ORM operations compatible with SQLAlchemy 2.0. It implements JWT-based authentication and role-based access control for security. Asynchronous tasks are handled via Celery with Redis as a broker and PostgreSQL as a backend, utilizing celery-sqlalchemy-scheduler for task persistence. The architecture includes Caddy as a reverse proxy for routing and static file serving, and Minio for object storage.

Quick Start & Requirements

• Install/Run: Use docker compose -f docker-compose-dev.yml up --build or make run-dev-build.
• Prerequisites: Docker, Make, Python >=3.9,<3.12, Poetry.
• Setup: Requires setting environment variables via .env.example.
• Docs: https://github.com/jonra1993/fastapi-alembic-sqlmodel-async

Highlighted Details

• Full async CRUD operations with JWT authentication and RBAC.
• Integrated Celery for asynchronous and scheduled tasks.
• Minio for object storage and Caddy for reverse proxying.
• UUID7 draft implementation for database unique IDs.
• Automated API documentation generation and pytest for testing.
• Includes a basic Langchain/OpenAI chatbot example via websockets.

Maintenance & Community

• Supported by the Allient development team.
• Contact: info@allient.io

Licensing & Compatibility

• License: MIT.
• Compatible with commercial use and closed-source linking.

Limitations & Caveats

The project is a template with a TODO list including adding comprehensive testing, JSONB field support, async Celery-SQLAlchemy-scheduler, and production deployment instructions via CI/CD. A Next.js frontend is also planned.