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

Uploaded Python 3

File details

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

File metadata

  • Download URL: brokkr_client-0.8.1.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.1.tar.gz
Algorithm Hash digest
SHA256 6440f9b82749851e0f69bd6bfa5e3f23a2d3d1482bf58d0e095211ede3f4c284
MD5 8847848e13090f3e69ad5961a207704a
BLAKE2b-256 922c4c894fa9e2d4a2cddef024139920a135b47c674b8b52d74ee5944ea42905

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: brokkr_client-0.8.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5651e9724c028490f5fb5f8a1b9b09f91a1a27a093de84cf6bb87cc8126ca961
MD5 962ef13a8ed942e2df016d90e878b026
BLAKE2b-256 2b225f7753b35230155642f201b7f7bd5057711c863ea5036f6dea1e64a78511

See more details on using hashes here.

Provenance

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