assisted-service-client

What it is and what it does

assisted-service-client is an auto-generated Python wrapper around the OpenShift Assisted Service REST API, built from Swagger/OpenAPI specifications. It provides typed classes and methods for interacting with cluster installation workflows, infrastructure environments, hosts, and event streams without hand-writing HTTP requests.

The package wraps core operations like registering infrastructure environments, binding and deregistering hosts, downloading cluster credentials and logs, and querying installation events. It handles authentication via API keys and manages request/response serialization through its runtime dependencies (urllib3, certifi, python-dateutil, six). It is intended for automation scripts, CI/CD pipelines, and tools that need to programmatically manage OpenShift cluster provisioning.

Use it for:

• Automate cluster registration and host binding workflows in CI/CD pipelines for OpenShift deployments.
• Query installation events and cluster status to build monitoring or alerting systems around assisted installations.
• Download cluster credentials and configuration files after installation completes.
• Manage infrastructure environments and host lifecycle (deregister, unbind, regenerate signing keys) in bulk operations.
• Integrate OpenShift assisted installation into custom provisioning orchestration tools.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Python client library for the OpenShift Assisted Service API, auto-generated from Swagger/OpenAPI specifications to enable programmatic cluster installation and infrastructure management.

Yes, if you are building automation or tooling around OpenShift Assisted Service. The package has low install friction, active maintenance, permissive licensing, and no known vulnerabilities. It is the official client for the API and saves you from hand-writing HTTP calls. Not relevant if you do not interact with the Assisted Service API.

Install

assisted-service-client on PyPI

pip install assisted-service-client

uv add assisted-service-client

poetry add assisted-service-client

Installing assisted-service-client

Before you install

Low friction install with stable, lightweight dependencies (certifi, python-dateutil, six, urllib3). Active maintenance with recent releases; last commit 2026-08-14.

License in practice

Licensed under Apache Software License (permissive), allowing use in commercial and open-source projects with minimal restrictions.

Quickstart

pip install assisted-service-client

import assisted_service_client
from assisted_service_client.rest import ApiException

configuration = assisted_service_client.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
api_instance = assisted_service_client.EventsApi(assisted_service_client.ApiClient(configuration))
api_response = api_instance.v2_list_events()

Requires Python 3.6 or later; API key credentials for the target Assisted Service endpoint.

Verify before relying

• Whether the auto-generated code is kept in sync with upstream API changes and how frequently.
• Performance characteristics and rate-limiting behavior when querying large clusters or event streams.
• Compatibility with different versions of the OpenShift Assisted Service API backend.

Package facts

Evidence: assisted_service_client-2.55.0.post68-py3-none-any.whl

Keywords: Swagger, AssistedInstall

Tags

More WWW/HTTP packages