SecDev Course Template

Стартовый шаблон для студенческого репозитория (HSE SecDev 2025).

Быстрый старт

python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\Activate.ps1
pip install -r requirements.txt -r requirements-dev.txt
pre-commit install
uvicorn app.main:app --reload

Ритуал перед PR

ruff check --fix .
black .
isort .
pytest -q
pre-commit run --all-files

Тесты

pytest -q

CI

В репозитории настроен workflow CI (GitHub Actions) — required check для main. Badge добавится автоматически после загрузки шаблона в GitHub.

Контейнеры

docker build -t secdev-app .
docker run --rm -p 8000:8000 secdev-app
# или
docker compose up --build

Эндпойнты

• GET /health → {"status": "ok"}
• POST /items?name=... — демо-сущность
• GET /items/{id}

Формат ошибок

Все ошибки — JSON-обёртка:

{
  "error": {"code": "not_found", "message": "item not found"}
}

См. также: SECURITY.md, .pre-commit-config.yaml, .github/workflows/ci.yml.