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
CLI navigation contract
The interactive CLI in axis/cli/ follows a menu-first model.
Router runtime is the only interactive execution path.
- Canonical route graph:
main -> devices -> device_operations -> {api|events|accounts}. device_operationsroutes to feature submenus using router navigation, not direct feature command execution.- Feature nodes (
api,events,accounts) own their local menu layout and selected-device context rendering. balways navigates toparent_id;ealways exits.
To keep the CLI reusable boundary clear:
- CLI concerns (menu keys, prompts, render text, router state) stay in
axis/cli/. axis/interfaces/andaxis/models/must remain presentation-agnostic and reusable by non-CLI consumers.- Domain layers return typed data/errors; CLI adapters map them to user-facing text and flow.
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.
Request and response typing
Vapix.api_request() is the single typed request entrypoint.
- Request models declare their decode contract with
ApiRequest[ResponseT]. - Every
ApiRequestsubclass must setresponse_typeexplicitly. - Decoded/read requests use their concrete response model as
response_type. - Write-style requests use
BytesResponseasresponse_type.
Examples:
@dataclass
class ListApisRequest(ApiRequest[GetAllApisResponse]):
response_type = GetAllApisResponse
@dataclass
class SetPortsRequest(ApiRequest[ApiResponse[bytes]]):
response_type = BytesResponse
Handler methods may unwrap .data when they intentionally preserve a bytes-returning boundary.
Example fallback policy:
LightHandlerparticipates in bothAPI_DISCOVERYandPARAM_CGI_FALLBACK.- In
PARAM_CGI_FALLBACK, it initializes only when not listed in API discovery and listed in parameters.
Event Instance Model Notes
EventInstance keeps name as the raw device-provided NiceName value.
EventInstance.source and EventInstance.data are typed containers (EventInstanceSource and EventInstanceData) built from SimpleItemInstance payloads.
For compatibility with integrations that still need the historical raw payload shape, EventInstance also exposes:
raw_source: returns{}or a dict or a list of dicts.raw_data: returns{}or a dict or a list of dicts.
1 maintainer
Metadata
1 maintainer
Release files for axis 74
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| axis-74.tar.gz | 145.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| axis-74-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 280.6 kB
Release files / axis-74.tar.gz
| Download URL | axis-74.tar.gz |
|---|---|
| Size | 145.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0e215d21ddb82a402f3d4add062a4106552017e60c3d0357e063b731ae87b2bf
|
|
BLAKE2b-256 checksum How to use checksums |
1ac70f0549b7394465a629c61acbba86d9701713fd9b5eba456afdae70557079
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
Release files / axis-74-py3-none-any.whl
| Download URL | axis-74-py3-none-any.whl |
|---|---|
| Size | 134.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
19cc109e36213dd3d1413e2ec21aecc10ef1e986f5a962f2445c789ba6a34a76
|
|
BLAKE2b-256 checksum How to use checksums |
abe11678886b547fca592892942cdda510b788d3449e9ac40451d8bc99578397
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
