Веб-сервис для взаимодействия с разными электронными дневниками. Подробная документация здесь
Нужно чтобы git
, make
, docker
и docker-compose
были установлены
Скачать проект с гитхаба
git clone https://github.com/Dnevnik365/web/
Установить зависимости
make build
Обновить зависимости
make update
Запустить проект
make start
Запустить проект в фоновом режиме
make up
Остановить контейнеры
make stop
<br
Удалить контейнеры и данные из БД
make rm
Запустить обновление БД(для последней версии укажите revision=head
)
make db-upgrade revision=<версия>
Запустить откат БД
make db-downgrade revision=<версия>
Проверить читаемость кода
make lint
Запустить все тесты
make test
Проверить покрытие кода тестами
make test-cov
Ниже все нужные переменные окружения. Примеры здесь
-
HOST
- хост сервера -
POSTGRES_USER
- юзернейм для базы данных postgres -
POSTGRES_PASSWORD
- пароль для БД -
POSTGRES_PORT
- порт БД -
POSTGRES_DB
- название БД -
REDIS_PASSWORD
- пароль для баз данных redis -
HOMEWORK_DB_PORT
- порт для бд с домашними заданиями -
PURPOSES_DB_PORT
- порт для бд с целями
-
fastapi - 0.110.2
-
asyncpg - 0.29.0
-
python-dotenv - 1.0.1
-
jinja2 - 3.1.4
-
python-multipart - 0.0.9
-
uvicorn - 0.29.0
-
pydnevnikruapi - 0.1.1
-
sqlalchemy - 2.0.29
-
redis - 5.0.4
-
alembic - 1.13.1
-
aiohttp - 3.9.5
-
flake8 - 7.0.0
-
pytest - 8.1.1
-
pytest-cov - 5.0.0
-
mypy - 1.10.0
-
httpx - 0.27.0