FastAPI Example Todo Application

FastAPI example ToDo Application with user authentication.

Stack:

• FastAPI
• PostgreSQL
• SQLAlchemy
• Alembic
• Docker

Developing

Install pre-commit hooks to ensure code quality checks and style checks

$ make install_hooks

Then see Configuration section

You can also use these commands during dev process:

• To run mypy checks

  $ make types
  

• To run flake8 checks

  $ make style
  

• To run black checks:

  $ make format
  

• To run together:

  $ make lint
  

Configuration

Replace .env.example with real .env, changing placeholders

SECRET_KEY=changeme
POSTGRES_PORT=5432
POSTGRES_DB=tododb
POSTGRES_PASSWORD=postgres
POSTGRES_USER=postgres
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/tododb

Local install

Setup and activate a python3 virtualenv via your preferred method. e.g. and install production requirements:

$ make ve

For remove virtualenv:

$ make clean

Local run

Run migration to create tables

$ make migrate

Run pre-start script to check database:

$  make check_db

Run server with settings:

$ make runserver

Run in Docker

!! Note:

If you want to run app in Docker, change host in DATABASE_URL in .env file to name of docker db service:

DATABASE_URL=postgresql://postgres:postgres@db:5432/tododb

Run project in Docker:

$ make docker_build

Stop project in Docker:

$ make docker_down

Register user:

$ curl -X 'POST' \
    'http://0.0.0.0:5000/api/v1/user' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
        "username": "test-user",
        "email": "[email protected]",
        "full_name": "Test Test",
        "password": "weakpassword"
    }'

If everything is fine, check this endpoint:

$ curl -X "GET" http://0.0.0.0:5000/api/v1/status

Expected result:

{
  "success": true,
  "version": "<version>",
  "message": "FastAPI Todo Application"
}

Web routes

All routes are available on / or /redoc paths with Swagger or ReDoc.

Project structure

Files related to application are in the main directory. Application parts are:

main
├── __init__.py
├── api
│   ├── __init__.py
│   └── v1
│       ├── __init__.py
│       ├── router.py
│       └── routes
│           ├── __init__.py
│           ├── status.py
│           ├── tasks.py
│           └── user.py
├── app.py
├── core
│   ├── __init__.py
│   ├── config.py
│   ├── dependencies.py
│   ├── exceptions.py
│   ├── logging.py
│   ├── security.py
│   └── settings
│       ├── __init__.py
│       ├── app.py
│       └── base.py
├── db
│   ├── __init__.py
│   ├── base.py
│   ├── base_class.py
│   ├── migrations
│   │   ├── env.py
│   │   ├── script.py.mako
│   │   └── versions
│   │       └── dfb75cfbf652_create_tables.py
│   ├── repositories
│   │   ├── __init__.py
│   │   ├── base.py
│   │   ├── tasks.py
│   │   └── users.py
│   └── session.py
├── models
│   ├── __init__.py
│   ├── task.py
│   └── user.py
├── schemas
│   ├── __init__.py
│   ├── response.py
│   ├── status.py
│   ├── tasks.py
│   └── user.py
├── services
│   ├── __init__.py
│   └── user.py
└── utils
    ├── __init__.py
    └── tasks.py