vexxhost-clientcore

The code every VEXXHOST API client would otherwise copy: a Keystone transport, RFC 9457 error handling, OpenStackClient plugin wiring, CLI argument parsers and model generation. Each service keeps its own client package, version and release cadence, and only service-specific code lives there.

It builds on keystoneauth1, openstack.config and osc-lib, the same libraries every OpenStack client uses. docs/naming.md records how clients are named and packaged, and which upstream code the core reuses.

pip install vexxhost-clientcore

What is shared

Service clients keep what is specific to them: their resource managers, OSC commands, generated models and tests.

Writing a client

# exampleclient/v1/client.py
from vexxhost_clientcore.client import ServiceClient


class Client(ServiceClient):
    service_type = "example"  # Keystone catalog type
    title = "Example"  # used in error messages
    endpoint_option = "--os-example-endpoint"
    client_name = "vexxhost-exampleclient"
    client_version = "0.1.0"

    def setup(self, http_client):
        self.things = ThingManager(http_client)


class ThingManager:
    def __init__(self, api):
        self.api = api

    def list(self):
        return self.api.get_json("things")["things"]

    def get(self, thing_id):
        return self.api.get_json(self.api.path("things", thing_id))

# exampleclient/osc/plugin.py
from vexxhost_clientcore import osc

API_NAME = "example"
API_VERSION_OPTION = "os_example_api_version"
API_VERSIONS = {"1": "exampleclient.v1.client.Client"}

_plugin = osc.Plugin(API_NAME, "Example", API_VERSIONS)
make_client = _plugin.make_client
build_option_parser = _plugin.build_option_parser

Depend on vexxhost-clientcore>=0.1,<0.2 and call the reusable workflows at a release tag. Name the client as docs/naming.md describes.

Development

python -m venv .venv
. .venv/bin/activate
pip install -e '.[test]' ruff
pytest
ruff check . && ruff format --check .

Changes here reach every client, so keep the API small and backwards compatible. To release, bump version in pyproject.toml and push a matching vX.Y.Z tag; the release workflow publishes it to PyPI.