busbar-admin (Python SDK)

A typed Python client for the Busbar Admin API (/api/v1/admin).

The client is generated from the typed OpenAPI 3.1 schema in openapi.json with openapi-python-client, so every response is a real dataclass (InfoView, TopologyInfo, ...) — not Any/dict.

PyPI package name: busbar-admin. (busbar is already taken on PyPI, so the admin SDK ships as busbar-admin.)

Versioning

The SDK carries its own semantic version, independent of the busbar server / OpenAPI info.version (currently 1.5.0). The current release is 0.2.0 (the 1.5.0 spec added operationIds, which renamed every generated function — a breaking change from 0.1.0). A given SDK release targets the frozen, additive-only /api/v1/admin surface and will keep working across server versions on that surface.

Install

pip install busbar-admin

Usage

The admin API authenticates with an x-admin-token header. Construct an AuthenticatedClient that sends the token under that header name (no Bearer prefix):

from busbar_admin import AuthenticatedClient
from busbar_admin.api.default import get_info
from busbar_admin.models import InfoView

client = AuthenticatedClient(
    base_url="http://localhost:8081",
    token="YOUR_ADMIN_TOKEN",
    # send the credential as `x-admin-token: <token>` instead of Authorization: Bearer
    auth_header_name="x-admin-token",
    prefix="",
)

with client as client:
    info: InfoView = get_info.sync(client=client)
    # `info` is TYPED — your editor autocompletes .version, .topology, .build, ...
    print("busbar version:", info.version)                 # -> "1.4.0"
    print("pools:", info.topology.pools)
    print("config version:", info.config_version)

Prefer Authorization: Bearer? Drop the auth_header_name/prefix overrides — the default AuthenticatedClient sends Authorization: Bearer <token>, which the admin API also accepts.

Async is available too (get_info.asyncio / .asyncio_detailed).

Regenerating the client

The committed client is generated from openapi.json. To re-derive it:

make generate     # pins openapi-python-client via requirements-dev.txt

CI regenerates on every PR/push and fails if the committed client drifts from openapi.json (git diff --exit-code).

License

Apache-2.0 © Busbar, Inc.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

busbar_admin-0.3.0.tar.gz (76.9 kB view details)

Uploaded Aug 3, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

busbar_admin-0.3.0-py3-none-any.whl (201.2 kB view details)

Uploaded Aug 3, 2026 Python 3

File details

Details for the file busbar_admin-0.3.0.tar.gz.

File metadata

Download URL: busbar_admin-0.3.0.tar.gz
Upload date: Aug 3, 2026
Size: 76.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for busbar_admin-0.3.0.tar.gz
Algorithm	Hash digest
SHA256	`41673daa43013f4d51466d75fb394436c14200d88d50bc55b37f3e7c9746e0d2`
MD5	`316a8be24295111eee14b97feb53f6b8`
BLAKE2b-256	`63e4699f685c95b162578713ef5381db2a8eb5ec8906013421d88574b7db6aaf`

See more details on using hashes here.

Provenance

The following attestation bundles were made for busbar_admin-0.3.0.tar.gz:

Publisher: release.yml on GetBusbar/busbar-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: busbar_admin-0.3.0.tar.gz
- Subject digest: 41673daa43013f4d51466d75fb394436c14200d88d50bc55b37f3e7c9746e0d2
- Sigstore transparency entry: 2332523118
- Sigstore integration time: Aug 3, 2026
Source repository:
- Permalink: GetBusbar/busbar-python@3c8eb2a5f80a748f6e56199962314dd4c7cf40f3
- Branch / Tag: refs/tags/v0.3.0
- Owner: https://github.com/GetBusbar
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@3c8eb2a5f80a748f6e56199962314dd4c7cf40f3
- Trigger Event: push