salute-api

Shared FastAPI runtime for Salute NLP scenarios: webhook, health, Pydantic message models, device-aware logging, and a MetricsSender protocol.

Install from PyPI:

pip install salute-api
# or
uv add salute-api

Quiz apps can still path-depend on a local checkout:

dependencies = ["salute-api"]

[tool.uv.sources]
salute-api = { path = "../salute-api", editable = true }

Layout

src/salute_api/   FastAPI factory, models, logging, metrics, scenario walker
tests/            contract and logging tests
ci/pipeline.py    release version and API compatibility checks

Ruff and ty settings in this pyproject.toml are the shared baseline. Apps extend the ruff config with:

[tool.ruff]
extend = "../salute-api/pyproject.toml"

Checks

uv sync
uv run ruff check .
uv run ruff format --check .
uv run ty check src tests
uv run pytest
uv run python ci/pipeline.py check

Release

version in pyproject.toml and __version__ in src/salute_api/__init__.py must be the same numeric x.x.x. On the default branch, GitLab CI lints, tests, classifies the API diff as patch, minor, or major, writes that version, rebuilds, and waits. The deploy job is manual. It tags vX.Y.Z and uploads dist/ to PyPI.

Set masked CI variables before deploying:

• UV_PUBLISH_TOKEN — PyPI API token from https://pypi.org/manage/account/token/
• GITLAB_TOKEN — project token with write_repository, used to push the release commit and tag

Tag pipelines are skipped, so the tag push does not publish again.

Local build:

uv build
uv publish
# or with an explicit token:
# uv publish --token $UV_PUBLISH_TOKEN