axis 71

A Python library for communicating with devices from Axis Communications

axis

Python project to set up a connection towards Axis Communications devices and to subscribe to specific events on the metadatastream.

Development setup

uv is required for development setup:

uv python install 3.14
uv sync --python 3.14 --all-extras

Or run the bootstrap script, which installs uv if needed and provisions Python 3.14 automatically:

./setup.sh

Dependencies are locked via uv.lock. Regenerate lock data when dependency inputs change:

uv lock

Run checks with uv:

uv run ruff check .
uv run ruff format --check .
uv run mypy axis
uv run pytest

Initial ty support is configured as an opt-in check and does not replace mypy:

uvx ty check

Initialization architecture

Vapix initialization is phase-based and driven by handler metadata:

• API_DISCOVERY: handlers initialized after API discovery.
• PARAM_CGI_FALLBACK: handlers that may initialize from parameter support when not listed in discovery.
• APPLICATION: handlers initialized after applications are loaded.

Handlers declare phase membership through handler_groups and may customize phase eligibility through should_initialize_in_group.

Example fallback policy:

• LightHandler participates in both API_DISCOVERY and PARAM_CGI_FALLBACK.
• In PARAM_CGI_FALLBACK, it initializes only when not listed in API discovery and listed in parameters.