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.8.0.tar.gz (7.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.8.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brokkr_client-0.8.0.tar.gz
  • Upload date:
  • Size: 7.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.8.0.tar.gz
Algorithm Hash digest
SHA256 214ac5ac717e5921ed18948e25d64a281ced224be064d9dc1df7ae67effe3896
MD5 39344924ee9354634d0cf996593532ea
BLAKE2b-256 de9227a8c45d9bfac3bb100225df1041ab4027c241b3d741a6d59a2be9196fb2

See more details on using hashes here.

Provenance

The following attestation bundles were made for brokkr_client-0.8.0.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.8.0-py3-none-any.whl.

File metadata

  • Download URL: brokkr_client-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1487f4282661310d6a8c4d1b12794eb24b03bca5de04ef97c308b615ed6b2f54
MD5 96514fce529ff2c9eb2a7c65b5eb67c6
BLAKE2b-256 67f73d0002777ed59e4c67563a9181c0c8a2ee3f1ebf137f6b3a4e0a8161a42d

See more details on using hashes here.

Provenance

The following attestation bundles were made for brokkr_client-0.8.0-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