{"id":34837294,"url":"https://github.com/arenadata/adcm-aio-client","last_synced_at":"2025-12-25T16:10:35.555Z","repository":{"id":261114077,"uuid":"881269680","full_name":"arenadata/adcm-aio-client","owner":"arenadata","description":"ADCM Client","archived":false,"fork":false,"pushed_at":"2025-12-12T08:14:16.000Z","size":457,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2025-12-21T23:41:06.963Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arenadata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-10-31T08:28:59.000Z","updated_at":"2025-12-12T08:14:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"e56bbaef-1c49-437f-9601-6ee8cbe4fa78","html_url":"https://github.com/arenadata/adcm-aio-client","commit_stats":null,"previous_names":["arenadata/adcm-aio-client"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/arenadata/adcm-aio-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arenadata%2Fadcm-aio-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arenadata%2Fadcm-aio-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arenadata%2Fadcm-aio-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arenadata%2Fadcm-aio-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arenadata","download_url":"https://codeload.github.com/arenadata/adcm-aio-client/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arenadata%2Fadcm-aio-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28032399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-25T02:00:05.988Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-25T16:08:56.617Z","updated_at":"2025-12-25T16:10:35.548Z","avatar_url":"https://github.com/arenadata.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ADCM AIO Client\n\nAsynchronous Client for ADCM (Arenadata Cluster Manager).\n\n\u003e The client supports the minimum version of ADCM `2.5.0`.\n\n## Introduction\n\nInstall `adcm-aio-client` using `pip`.\n\n\u003e `adcm-aio-client` requires Python 3.12+.\n\n```shell\npip install adcm-aio-client\n```\n\n## QuickStarts\n\nTo work with clusters, you need to connect to the backend of an existing ADCM.\n\nFirst, set up your credentials:\n\n```python\nfrom adcm_aio_client import ADCMSession, Credentials\n\ncredentials = Credentials(username=\"admin\", password=\"admin\")\n```\n\nSecond, you need to get session with ADCM backend:\n\n```python\nasync with ADCMSession(url=\"http://127.0.0.1:8000\", credentials=credentials) as client:\n    clusters = await client.clusters.all()\n```\n\nThe full list of available APIs can be found in the [Guides](#guides) section.\n\n## Guides\n\n- Examples of the available API for the `Bundle` entity can be found [here](/tests/integration/examples/test_bundle.py)\n- Examples of the available API for the `Cluster` entity can be\n  found [here](/tests/integration/examples/test_cluster.py)\n- Examples of the available API for the `Service` entity can be\n  found [here](/tests/integration/examples/test_service.py)\n- Examples of the available API for the `Hostprovider` entity can be\n  found [here](/tests/integration/examples/test_hostprovider.py)\n- Examples of the available API for the `Host` entity can be found [here](/tests/integration/examples/test_host.py)\n- Examples of the available API for the `Host Group` entity can be\n  found [here](/tests/integration/examples/test_host_groups.py)\n\n## Contributing\n\n### Development\n\nTo start developing ADCM AIO Client create a fork of\nthe [ADCM AIO Client repository](https://github.com/arenadata/adcm-aio-client) on GitHub.\n\nThen clone your fork with the following command replacing YOUR-USERNAME with your GitHub username:\n\n```shell\ngit clone https://github.com/\u003cYOUR-USERNAME\u003e/adcm-aio-client.git\n```\n\nWe use [Poetry](https://python-poetry.org/) to automate testing and linting. You\nneed [installed](https://python-poetry.org/docs/#installation) Poetry version at least 2.0.0.\n\nYou can now install the project and its dependencies using:\n\n```shell\npoetry install\n```\n\n### Linting\n\nThe project uses the [ruff](https://github.com/astral-sh/ruff) formatter to preserve the source code\nstyle. [Pyright](https://github.com/microsoft/pyright) is used for static type checking.\n\nTo install the dependencies, run:\n\n```shell\npoetry install --with dev\n```\n\nTo check the code style, run:\n\n```shell\npoetry run ruff check\n```\n\nTo check the types, run:\n\n```shell\npoetry run pyright\n```\n\nTo run the code auto-formatting:\n\n```shell\npoetry run ruff format\npoetry run ruff check --fix\n```\n\n### Testing\n\nFor testing, we use [pytest](https://docs.pytest.org/en/stable/index.html).\n\nTo install the dependencies, run:\n\n```shell\npoetry install --with test\n```\n\nTo run the unit tests:\n\n```shell\npoetry run pytest tests/unit\n```\n\nTo run the integration tests:\n\n```shell\npoetry run pytest tests/integration\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farenadata%2Fadcm-aio-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farenadata%2Fadcm-aio-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farenadata%2Fadcm-aio-client/lists"}