cnaas-nms-api-client
A typed Python client library for the CNaaS NMS API, auto-generated from the OpenAPI specification using openapi-python-client.
Installation
pip install cnaas-nms-api-client
Or install directly from GitHub:
pip install git+https://github.com/acidjunk/cnaas-nms-api-client.git
Usage
from cnaas_nms_api_client import AuthenticatedClient
from cnaas_nms_api_client.api.devices import get_devices_api
client = AuthenticatedClient(
base_url="https://your-cnaas-instance/api/v1.0",
token="your-api-token",
)
# Example: list devices
response = get_devices_api.sync_detailed(client=client)
print(response.status_code)
Every endpoint has both sync_detailed and asyncio_detailed variants for synchronous and async usage.
Development
This project uses uv for dependency management.
# Clone and install
git clone https://github.com/acidjunk/cnaas-nms-api-client.git
cd cnaas-nms-api-client
uv sync
# Regenerate client from OpenAPI spec
make generate
# Build package
make build
# Lint
make lint
Regenerating the Client
If the upstream CNaaS NMS API changes:
- Place the updated Swagger 2.0 spec in
swagger_files/swagger.json - Run
make convertto produce the OpenAPI 3.1 spec - Run
make generateto regenerate the Python client
License
Apache-2.0
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cnaas_nms_api_client-0.2.0.tar.gz.
File metadata
- Download URL: cnaas_nms_api_client-0.2.0.tar.gz
- Upload date:
- Size: 21.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39c52b1d8c4e694449d0bde12f793e3fc87185d3854995db0206b28e4fd481af
|
|
| MD5 |
0de234ee588693b76e4557532e4d7ffd
|
|
| BLAKE2b-256 |
a1cc127e62ee90588e81e3ceb2e84191ac059f87b9631867dd8de381a3a1773b
|
Provenance
The following attestation bundles were made for cnaas_nms_api_client-0.2.0.tar.gz:
Publisher:
publish.yml on acidjunk/cnaas-nms-api-client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cnaas_nms_api_client-0.2.0.tar.gz -
Subject digest:
39c52b1d8c4e694449d0bde12f793e3fc87185d3854995db0206b28e4fd481af - Sigstore transparency entry: 2211645699
- Sigstore integration time:
-
Permalink:
acidjunk/cnaas-nms-api-client@f96c2f0704d2cd9e6aeef291c46173449206d297 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/acidjunk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f96c2f0704d2cd9e6aeef291c46173449206d297 -
Trigger Event:
push
-
Statement type:
File details
Details for the file cnaas_nms_api_client-0.2.0-py3-none-any.whl.
File metadata
- Download URL: cnaas_nms_api_client-0.2.0-py3-none-any.whl
- Upload date:
- Size: 108.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d7e7a3b6ccb484a95cd226663ffe914b687997b72b3b63128191dcbdacb0e11
|
|
| MD5 |
8d62379ab763f90ed2080c5f2b3a8e57
|
|
| BLAKE2b-256 |
41cfee062027daab5232ba9f1cc470e783d520e5cc496a1f92f4340002199595
|
Provenance
The following attestation bundles were made for cnaas_nms_api_client-0.2.0-py3-none-any.whl:
Publisher:
publish.yml on acidjunk/cnaas-nms-api-client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cnaas_nms_api_client-0.2.0-py3-none-any.whl -
Subject digest:
8d7e7a3b6ccb484a95cd226663ffe914b687997b72b3b63128191dcbdacb0e11 - Sigstore transparency entry: 2211645728
- Sigstore integration time:
-
Permalink:
acidjunk/cnaas-nms-api-client@f96c2f0704d2cd9e6aeef291c46173449206d297 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/acidjunk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f96c2f0704d2cd9e6aeef291c46173449206d297 -
Trigger Event:
push
-
Statement type:
