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

Uploaded Python 3

File details

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

File metadata

  • Download URL: brokkr_client-0.6.0.tar.gz
  • Upload date:
  • Size: 4.1 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.6.0.tar.gz
Algorithm Hash digest
SHA256 1cb3975b3725d1f2bebc8a5c8552b79d319941014b35baa6423fef021ff3427f
MD5 0df87919514ffe28513c8879c415ff35
BLAKE2b-256 3e61c85296099163b221cb70cba389ea1feae0706f7ee7d20252e792a1b8d700

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: brokkr_client-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 31a4a69970864b1a6644911bc5173d1794be355197ef762a4ce7ccd98ffd2472
MD5 f385d7aef8f47264a03207f40ff4a6fd
BLAKE2b-256 b8ee4c2a2ea3d5c1d5b40b2df3c36915e0644a12e299d67ed9140f779e8566e3

See more details on using hashes here.

Provenance

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