northpowered/fastapi-boilerplate

Custom FastAPI boilerplate with Piccolo ORM, JWT auth, config file and Hashicorp Vault support

FastAPI boilerplate

Version: 1.1.2

Work in progress, please read issues

Full documentation is available on Github pages

Another FastAPI Boilerplate with:

• FastAPI as a base ASGI app
• Piccolo ORM for a database operations
• Piccolo Admin GUI for a convenient database management
• Hashicorp Vault integration for DB credentials (with auto-rotating), JWT secrets and other
• Custom Accounting CRUD application for managing
  • Users
  • Roles
  • Groups
  • Permissions
  • Security policies
• JWT autehntication
• API versioning
• PyDantic-based flexible configfile parcer (toml and yaml formats supports)
• Typer-based CLI management
• Prometheus endpoint based on Starlette exporter
• OpenTelemetry collector
• Request ID propagation for logger, Request and Response (injection to Headers)
• CI pipeline for linting and testing (with coverage)

Usage

Base usage

Usage: main.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help                          Show this message and exit.

Commands:
  aaa  Operations with users and other AAA objects
  db   Operations with DB
  run  Run application in uvicorn server with defined config file

All CLI commands with descriptions are placed here

Installation

We`re strongly reccomend to use Poetry

Create new virtual environment or enter to an existing one

poetry shell

Install all dependencies from pyproject.toml

poetry install

Run your app

python3 main.py run

fastapi-boilerplate's Issues

[Test] Codecov integration

[BUG] config-file arg for CLI not working

Config loader uses default value before propagating arg from CLI

[Test] Startup exceptions

TRACE_ID_LENGTH into the config file

[Docs] Base docs structure

JWT configuration in config file

Configuration options for JWT should be accessed from config.ini in a separate section

Username/E-mail selection for authentication

Developer should choose, what type of credentials are available for an auth:

• username
• email
• API token

Multiple options should be available

[Test] Testing CLI app

Different file extentions for configuration module

configuration module MUST supports:

1. YAML
2. TOML
3. HCL

Also, subsections in config file

[Test] Accounting-CRUDs

Tests for accounting CRUDs

Fix 5 Maintainability issues in multiple files

CodeFactor found multiple issues last seen at 2696882:

Trailing spaces

• .github\workflows\codeql-analysis.yml:64
• .github\workflows\codeql-analysis.yml:55
• .github\workflows\codeql-analysis.yml:51
• .github\workflows\apisec-scan.yml:7
• .github\workflows\apisec-scan.yml:6

JWT key generation

Key for signing JWT should be generated through CLI interface

Cache integration

Unified API inside of FastAPI app for caching

Priority on Redis

Special API for db models:
request -> object API8 -> pull from cache -> if not, pull from db and push to cache

[Test] CLI running main app test

Migration to Poetry

Migrate from PIP to Poetry

API versioning for FastAPI routers

Add VERSION into endpoints URL like a DeanWay/fastapi-versioning, but with support of FastAPI APIRouter class

Request ID propagation

Every request should have an ID for logging and tracing

As a middleware

CLI vault management + tests

OpenTelemetry integration

ToDO:

1. Native FastAPI profiling for endpoints
2. Context manager for child spans
3. Integration with Piccolo profiling
4. Fully-configurated from config.ini file

Priority on Jaeger