- Docker.
- Docker Compose.
- Poetry for Python package and environment management.
- Create ".env" file and add environment variables to it:
# Base SECRET_KEY=some-secret-key PROJECT_NAME='Some Project Name' SERVER_HOST=http://0.0.0.0:8881 # Databases POSTGRES_USER=postgres POSTGRES_PASSWORD=postgres POSTGRES_HOST=postgres POSTGRES_DB=postgres POSTGRES_TEST_DB=test PGDATA=/var/lib/postgresql/data/pgdata # SMTP SMTP_USER=some-email SMTP_PASSWORD=some-password # Auth FIRST_SUPERUSER_USERNAME=user@user.com FIRST_SUPERUSER_PASSWORD=password FIRST_SUPERUSER_FIRST_NAME='first name' FIRST_SUPERUSER_LAST_NAME='last name'- To generate 32 byte SECRET_KEY:
$ openssl rand -hex 32- Other project settings (e.g. SMPT) you can see in "app/core/config.py"
- Run server with all dependencies:
$ docker-compose up --build- Add pre-commit hook
$ pre-commit installTesting is done with pytest, tests are placed in the "tests" directory
For testing, you should go inside the container and run the command pytest .
$ docker exec -it <FastAPI container ID> bash $ pytest tests --asyncio-mode=auto-> *app* -> *api* — layer with logic for processing requests via api -> *core* — global things for the project, like settings (`config.py`) -> *db* — database and session initialization -> *models* — models in SQLAlchemy terminology (not to be confused with *schemas* in pydantic and business models) -> *schemas* — schemes for validating/serializing request/response objects (they are also models in pydantic terminology) -> *services* — service layer, all business logic is placed here. -> *utils* — utility logic. -> *tests* — root for tests -> *.env.template* — file to list all environment variables used inside the service - After creating the model in
app/models, you need to import it inapp/db/base.py(in order to make it visible to alembic) - Make migrations (run inside container)
$ alembic -n postgres revision --autogenerate -m "add column last_name to User model"- Run migrations
$ alembic -n postgres upgrade head- Postgres
$ alembic -n postgres revision --autogenerate -m "text" $ alembic -n postgres upgrade head $ alembic -n postgres downgrade -1