Skip to main content

Ergonomic Python wrapper around the auto-generated brokkr-client-generated low-level client

Project description

brokkr-client

Ergonomic Python client for the Brokkr broker API.

pip install brokkr-client

The import name is brokkr (from brokkr import BrokkrClient); the PyPI distribution name is brokkr-client.

Versions track the broker release in lockstep — brokkr-client 0.3.x is the canonical client for broker 0.3.x.

This is a thin wrapper around the auto-generated brokkr-client-generated package (produced by openapi-python-client from the broker's OpenAPI spec). The wrapper adds:

  • A single-credential constructor that injects the Authorization header on every request. The three security schemes the spec declares (admin_pak / agent_pak / generator_pak) all map to the same header and the broker disambiguates at runtime — the wrapper hides that detail.
  • BrokkrError, a single exception type that wraps the generated typed ErrorResponse and exposes .code for stable pattern-matching.
  • An opt-in retry(...) helper with exponential backoff for transient transport / 5xx failures. Retry is per-call so callers decide which operations (typically idempotent GETs) are safe.

Pagination iterators are intentionally absent: the v1 broker API returns full collections without cursor tokens. Stream-style adapters belong here when the API adds pagination.

The wrapper is intentionally small. Most of the surface is the generated client; reach for it via client.api when the wrapper doesn't cover what you need.

Project details


Download files

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

Source Distribution

brokkr_client-0.4.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

brokkr_client-0.4.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file brokkr_client-0.4.1.tar.gz.

File metadata

  • Download URL: brokkr_client-0.4.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for brokkr_client-0.4.1.tar.gz
Algorithm Hash digest
SHA256 eb8dcf1a3cbc8da4ca72e93973a63d6fce9574e3507c131a3b137e904900f3f5
MD5 5debfa51a5940532830ee8862f263f4e
BLAKE2b-256 f127ca81f8af19966fd0d6aa401485ffbc70d96389dc7b1e4bf915aed757a2de

See more details on using hashes here.

Provenance

The following attestation bundles were made for brokkr_client-0.4.1.tar.gz:

Publisher: release-sdks.yml on colliery-io/brokkr

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

File details

Details for the file brokkr_client-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: brokkr_client-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for brokkr_client-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 47fe01c2a7c30efde583be45db3f9e846dedef68c67086fe5b309b7e1928aa27
MD5 17f00e5f4bb4284cc3eab134de60077a
BLAKE2b-256 2cb8690cab6d0671d3739ec6e21235302a4684b645e8b4b00d88c6ad75e672ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for brokkr_client-0.4.1-py3-none-any.whl:

Publisher: release-sdks.yml on colliery-io/brokkr

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page