fastapi-postgresql-boilerplate

Overview #

🚀 FastAPI is a modern, fast (high-performance) web framework for building APIs with Python 3.6+ based on standard Python-type hints.
I made and used this boilerplate for projects that I’m working on. 🧑‍💻
it was powerful for building data-driven applications using schema for data validation, serialization, and documentation. 📝

Description #

A boilerplate that can serve as a base for FastAPI with PostgreSQL
Made with FastAPI, PostgreSQL, Docker, Coverage, SQLAlchemy, Pytest, Black, Flake8, Isort, and Poetry.

Features #

Developer experience #

• 🐍 Python 3.10 for programming language
• 🚀 FastAPI for handling HTTP requests and responses
• 🐳 Docker for containerization
• 🐘 PostgreSQL for database
• 📦 Poetry for dependency management
• 📈 Coverage for code coverage
• 🧪 Pytest for unit and integration testing
• 💾 SQLAlchemy ORM for interacting with a database
• 🚧 Flake8 for linting
• 🎨 Black for code formatting
• 📚 Isort for sorting imports

Back-end app features #

• 🚫 JWT authentication for secure access to the API
• 🎢 Layered architecture. (Controller, Service, Repository, Model)
• 📦 Dependency injection for better code organization
• 📝 Swagger and Redoc for API documentation and testing
• ♻️ Schema validation for input and output data

Requirements #

• Python 3.10
• Poetry
• PostgreSQL
• Docker

Getting Started #

Every command below except build and run is executed in a docker container.

Set Environment Variables #

# Copy service env file
$ cp .env.example .env
# Copy db env file
$ cp .db.env.example .db.env

Build and run the app with Docker Compose #

# Build docker image
$ docker-compose build

# Run the app in the background
$ docker-compose up -d

# Watch logs
$ docker-compose logs -f

# Execute a command in a running container
$ docker-compose exec app <command>

Migrate database #

before test or use the app, you need to migrate the database.

# init User table
$ docker-compose exec app poetry run alembic upgrade head

Test #

# Run unit tests using pytest
$ docker-compose exec app poetry run pytest

Lint and format #

# Run flake8
$ docker-compose exec app poetry run flake8

# Run black
$ docker-compose exec app poetry run black .

# Run isort
$ docker-compose exec app poetry run isort .

What’s next? #

• Handle scheduled tasks with Celery