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

Uploaded Python 3

File details

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

File metadata

  • Download URL: brokkr_client-0.4.0.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.0.tar.gz
Algorithm Hash digest
SHA256 0486d310a2c75d3a1b1910c6113b4a6c8bae8279ae6d63a893b0553ce70d072e
MD5 9732bb57639e9bff53b4d4e65ce6eaf4
BLAKE2b-256 5ca407bbf7fb658ef4d57c57a58ad8296477cf6828f1f328786efdd1618d3628

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: brokkr_client-0.4.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 25d5d07cde549c5b359b533eb98358b583b09759a1182c57988af76f9354e6d6
MD5 77bed49681f708fcffa2ab3a9afd8c9a
BLAKE2b-256 024a66038f5fc1debb2f9e2513e6dd1a6b85f236fbda6ebee8cdc77059809d2a

See more details on using hashes here.

Provenance

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