GitHunt
LI

likeinlife/video_api

API-сервис для получения данных с сайта FarPost

Описание

API-сервис для получения данных с сайта FarPost

Настройка

  1. Необходимо скопировать sample.env в docker-compose/.env. Для этого выполните команду make env

Запуск

  1. make storages - запустить PostgreSQL
  2. make app - запустить приложение
  3. make down-all - закрыть

Проверка работоспособности

При следовании инструкции, на локальном хосте должен открыться порт 8000.

Swagger доступен по URL: http://localhost:8000/api/docs/

Тестирование

Реализованы юнит- и интеграционные тесты

Запуск - make tests

Удаление артефактов - make down-tests

Реализованные дополнительные требования

  1. Приложение построено, следуя принципам слоистой архитектуры
  2. Использовалась ORM SQLALchemy
  3. Добавлена регистрация, аутентификация, авторизация пользователей, используя сессии

Стек

  1. Python3.11
  2. FastAPI
  3. SQLAlchemy
  4. Docker
  5. PostgreSQL
  6. alembic
  7. pydantic, pydantic-settings
  8. poetry
  9. dishka
  10. structlog

Скриншоты





Languages

Python94.7%Makefile2.1%Mako1.3%Dockerfile1.2%Shell0.7%

Contributors

Created June 6, 2024
Updated June 6, 2024