Диаграмма компонентов

Глобальные зависимости

• Python 3.8+
• virtualenv
• libpq-dev
• build-essential
• python3-dev
• redis-server
• rabbitmq-server
• postgresql

Документация по HTTP API

Для просмотра документации понадобится утилита redoc

redoc-cli serve src/entrypoints/web/docs/specs.yaml --watch

Коды HTTP исключений

Ссылка

Создание окружения

virtualenv -p python3.8 .venv

Установка зависимостей

make install

Тесты

Остановится после первой ошибки

make test

Web сервер

make run_web

Создание файла миграции

make migration name="001_init"

Применение миграций

Предварительно нужно создать базу данных и указать ее uri

make migrate_up

make migrate_down

Docker

Сборка докер-образа веб сервера

make docker_build

Запуск/остановка docker-compose dev окружения

make docker_up

make docker_down

Применение миграций для докер контейнера

make docker_migrate_up

make docker_migrate_down

Запуск тестов внутри докер контейнера

make docker_test