Repository navigation
0.1.0
Immutable
release. Only release title and notes can be modified.
First release of the official Python client for the Yama v2 API. Install it with pip install yama-client (or uv add yama-client) and import it as yama. It needs Python 3.10 or newer.
Added
Yamaclient with methods for every v2 operation:api_key,buildings,units,contacts,codesandcalls, returning typed models fromyama.models.- Automatic pagination, timeouts, and retries that honour
Retry-After. Reads, replaces, updates and deletes are retried after a 5xx or network error. codes.createis safe to retry: it sends anIdempotency-Key, and a failed create's error carries the key asidempotency_key.- Request models that check codes (3 to 15 digits) and names (at most 255 characters) before anything is sent.
calls.listtakes timezone-awarestartandend, so you can ask for a local day in any time zone, and polling for recent calls takes one request.- Typed exceptions for every failure, each with the API's
request_idto quote to Yama support. Yama.with_options()for a shorter timeout or fewer retries at one call site.- Structured, key-free logging through the
yamalogger. yama.testing.fake_transport(), an in-memory Yama API for testing integrations without a network or a key.- Documentation with a guide and an API reference.