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

Uploaded Python 3

File details

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

File metadata

  • Download URL: brokkr_client-0.8.3.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.3.tar.gz
Algorithm Hash digest
SHA256 b7eac043a5ad2f77fa98aeb2676e22202fb232f489a05497e6557dda8c6e6f23
MD5 17c9b21fc4ca9a1529f2fb2f5bc8b4e6
BLAKE2b-256 317fc28610e58525b3bf5d20fa009a59b03acabfdb9cdd1bd4f37fec41fee38c

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: brokkr_client-0.8.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 84f507a9136c1531fa92f9628d3702bbff201f17a1d43fe6b6adf6b9a1f5af86
MD5 7fb0a77f9b559b4c7de81d9b8c946cbb
BLAKE2b-256 15d0a87e49a1df5a9118ef17855c17b151aff167f3e75c1d7cee723ab9ef1cfc

See more details on using hashes here.

Provenance

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