ADCM AIO Client
Asynchronous Client for ADCM (Arenadata Cluster Manager).
The client supports the minimum version of ADCM
2.5.0.
Introduction
Install adcm-aio-client using pip.
adcm-aio-clientrequires Python 3.12+.
pip install adcm-aio-client
QuickStarts
To work with clusters, you need to connect to the backend of an existing ADCM.
First, set up your credentials:
from adcm_aio_client import ADCMSession, Credentials
credentials = Credentials(username="admin", password="admin")
Second, you need to get session with ADCM backend:
async with ADCMSession(url="http://127.0.0.1:8000", credentials=credentials) as client:
clusters = await client.clusters.all()
The full list of available APIs can be found in the Guides section.
Guides
- Examples of the available API for the
Bundleentity can be found here - Examples of the available API for the
Clusterentity can be found here - Examples of the available API for the
Serviceentity can be found here - Examples of the available API for the
Hostproviderentity can be found here - Examples of the available API for the
Hostentity can be found here - Examples of the available API for the
Host Groupentity can be found here
Contributing
Development
To start developing ADCM AIO Client create a fork of the ADCM AIO Client repository on GitHub.
Then clone your fork with the following command replacing YOUR-USERNAME with your GitHub username:
git clone https://github.com/<YOUR-USERNAME>/adcm-aio-client.git
We use Poetry to automate testing and linting. You need installed Poetry version at least 2.0.0.
You can now install the project and its dependencies using:
poetry install
Linting
The project uses the ruff formatter to preserve the source code style. Pyright is used for static type checking.
To install the dependencies, run:
poetry install --with dev
To check the code style, run:
poetry run ruff check
To check the types, run:
poetry run pyright
To run the code auto-formatting:
poetry run ruff format
poetry run ruff check --fix
Testing
For testing, we use pytest.
To install the dependencies, run:
poetry install --with test
To run the unit tests:
poetry run pytest tests/unit
To run the integration tests:
poetry run pytest tests/integration
Metadata
Release files for adcm-aio-client 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| adcm_aio_client-0.2.1.tar.gz | 37.0 kB | Without provenance | Details for adcm_aio_client-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| adcm_aio_client-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for adcm_aio_client-0.2.1-py3-none-any.whl |
Total release size: 94.0 kB
Release files / adcm_aio_client-0.2.1.tar.gz
| Download URL | adcm_aio_client-0.2.1.tar.gz |
|---|---|
| Size | 37.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5c13e9b78a839ce3d7b5f315ddb269868b7c964fbdafaa80cfd96b37a597c5e8
|
|
BLAKE2b-256 checksum How to use checksums |
a4a4c4cb9ebe801c37dd5a854afbd2c753a52623cfb7f964dc32964046019e7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.12.7 Linux/5.4.0-216-generic
|
Release files / adcm_aio_client-0.2.1-py3-none-any.whl
| Download URL | adcm_aio_client-0.2.1-py3-none-any.whl |
|---|---|
| Size | 57.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9920ee92474da88115208ffccbe6dedbb22d5d53a5594786abeb0e7a44394c6b
|
|
BLAKE2b-256 checksum How to use checksums |
2625ee0b145bacb9a189c7e9bbe98f8f6a136d97c891ec1671ab589280cc244e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.12.7 Linux/5.4.0-216-generic
|
Security for adcm-aio-client 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.