Skip to content

Latest commit

 

History

History
286 lines (194 loc) · 7.86 KB

README.md

File metadata and controls

286 lines (194 loc) · 7.86 KB
Raw

Test Coverage Python 3.11

🐍💨 FastAPI Rocket Boilerplate to build an API based in Python with its most modern technologies!

Python Fastapi Postgresql Celery Rabbitmq Redis Docker

Also sqlmodel, pydantic, alembic, poetry, ...

🧩 Features

  • Infrastructure: the common services that every backend needs, served in local by Docker Compose.
  • Easy: all the commands ready by Makefile.
  • Fast: thanks to Fastapi and async programming.
  • Async: Celery using RabbitMQ as broker and Redis as backend.
  • ORM: custom sqlmodel orm as django orm and mongoengine.
  • Authentication: OAuth2 with access/refresh tokens.
  • Admin dashboard: custom admin dashboard as django by sqladmin.
  • Rock-Solid Reliability: CI and pre-commit by Trunk. Integrity testing and covered by unit test at +95%.
  • Frontend friendly: auto generation of SDK Typescript client.

⚙️ Requirements

🎛️ Use

🔧 Installation

  1. Clone the repo

  2. Create a virtual environment:

python3.11 -m venv venv
  1. Install the requirements with Poetry for developing, testing and debugging purposes. Also install Trunk for pre-commit and code quality.
make install

VS Code

If you are using VS Code, I recommend you to install some plugins:

  • Trunk: for improving the quality code.

ℹ️ You can test the pre-commit without committing running trunk check

Sentry Integration

To integrate Sentry for error monitoring, add the Sentry DSN (Data Source Name) to the .env file. Set up your environment by signing in to Sentry to create a project and obtain the Sentry DSN.

In the .env file, include the following variable:

SENTRY_DSN=your_sentry_dsn_here

With this configuration, errors will be captured and reported to your Sentry project for effective monitoring.

🔌 Build and run

Build and run the Docker services for using in Locaql.

make run

Congrats! the API is working at this point, you can check:

For admin, use:

ADMIN_USER=superuser
ADMIN_PASS=admin

For generating the SDK frontend client (the app should be running):

make generate_sdk

You will find the generated client in generate_client/openapi.json

🧪 Test

Run pytest with coverage for unit testing.

make test

You do not need to run inside Docker container.

The DB is replaced by a SQLite db in memory 😎

🚚 Migrations

Use Alembic for DB migrations.

If you create a new model, import it in: app/core/db/migrations/models.py

After this, or modified a previous model, create the migration document:

docker-compose run app alembic revision --autogenerate -m "your commit"

If you are trying to do something complicated, maybe you need to fix the file manually.

Migration file should be created inside the Docker container because the DB url is referencing the Docker network domain.

Migrations will run when docker compose up, but you can run them manually:

docker-compose run app alembic upgread head

🛠 Extend

Basically, you will want to create new services that contain endpoints and models. And of course, it is almost completely sure you need to add new extra dependencies.

You can use the service user as reference.

📦 Models

If you want to create a new model to be stored in the DB, you should follow these steps:

  1. Create a new Class based in ModelCore with table=True
from app.core.base.models import ModelCore

class NewModel(ModelCore, table=True):
    unique_property: str
  1. Import the new class into the migration model file app.core.db.migrations.models
  2. Create a new migration
  3. Create an AdminModel in app.services.admin.models:
from app.core.admin.models import ModelViewCore

class NewModelAdmin(ModelViewCore, model=NewModel):
    # You can add config settings here for the Admin panel.
    pass
  1. Append it in admin_models into app.services.admin.config

🚏 Routes

If you want to create a new view protected by auth, you should include the get_current_user dependency.

Here you have an example of a new service with a protected route:

from fastapi import APIRouter, Depends

from app.core.auth.functions import get_current_user

router = APIRouter(
    prefix="/security",
    tags=["security"]
)

@router.get("/protected")
def protected_route(current_user: str = Depends(get_current_user)):
    """ Endpoint for auth test"""
    return {"message": f"¡Hola, {current_user}! This is a protected url and you are inside!"}

And then append the router in routers into app.main

For creating new users, they can register by themselves or be added by Admin panel.

🏗️ Dependencies

Use Poetry like:

poetry add <new_dependency>

🗜️ Environment variables

You should change the next env vars in .env:

  • Password hash:
    • SECRET_KEY: run in the terminal openssl rand -base64 32 to generate a new one
  • Admin superuser:
    • ADMIN_USER
    • ADMIN_PASS

Also, it is possible you want to modify the expiry time of access/refresh tokens.

🔮 Future features

Refactor

  • Organise better the root files

Monitoring

  • Add logging
  • Add Sentry
  • Add Flower

Testing

  • Integrity tests
  • pytest-alembic
  • Cover 100% with unit-testing

Quality code

  • Use a complete quality check for the code and pre-commit

Async

  • Use 100% async/await for routes and database connections

Auth

  • Authentication client with Google

Admin

  • Search events by model AND id
  • Fix popup for reverse_delete
  • Relationship of records into model details (performance)
  • Fix export CSV