gyolkin / user_service

VK Internship Test Task

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

User Service

Главный баннер

Python 3.10 Poetry Docker Ruff

User Service - простая ботоферма, которая отдает реальные учетные данные пользователя по требованию для использования в E2E-тестах.

Стек приложения:

  • Python
    • FastAPI
    • Pydantic
    • SQLAlchemy & alembic
    • Dishka (DI framework)
  • PostgreSQL

Чтобы начать работу, клонируйте данный репозиторий и перейдите в корневую директорию приложения.

Локальный запуск

Используется пакетный менеджер Poetry. Чтобы установить зависимости, выполните следующую команду:

poetry install

Активируйте виртуальное окружение:

poetry shell

Примените последнюю версию базы данных. Для локальной разработки будет создана dev.db база данных, использующая SQLite:

alembic upgrade head

Запустите приложение:

uvicorn src.user_service.main:create_production_app

Вы можете начать пользоваться приложением через интерактивную документацию.

Запуск с помощью Docker

Для запуска приложения в production-ready окружении создайте .env файл по образцу .env.example. Выполните команду:

docker compose up --build -d

Вы можете начать пользоваться приложением через интерактивную документацию.

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

Предполагается, что вы выполнили все шаги из раздела Локальный запуск.

Приложение покрыто тестами. Для запуска тестов используйте команду:

pytest -l

При необходимости создайте coverage-репорт в удобном формате:

pytest --cov=src/user_service --cov-report html

About

VK Internship Test Task


Languages

Language:Python 95.0%Language:Dockerfile 2.1%Language:Mako 1.7%Language:Shell 1.2%