kiapi-relay 0.3.0

Shared relay transport for kiapi: request/response schemas, the relay protocol, and a client to reach a kiapi instance over a relay (local filesystem or GCP).

kiapi-relay

English | 日本語

Shared relay transport for kiapi. It provides the relay protocol, the request/response schemas, the in-process request runner, and a client for issuing requests to a kiapi instance over a relay.

This package is platform-agnostic and is depended on by both kiapi (the server side, which runs the relay runner) and kiapi-proxy (the client side, which forwards HTTP requests over a relay).

Installation

pip install kiapi-relay

# With the GCP relay backend
pip install "kiapi-relay[gcp]"

Backends

Module	Description	Extra
kiapi_relay.impl.local	Filesystem-backed relay for local development and verification.	—
kiapi_relay.impl.gcp	GCP relay (GCS payloads + Firebase Realtime Database notifications).	gcp

Usage

from kiapi_relay import RelayRequest, RelayResponse, relay_registry

# Resolve a configured relay and issue a request over it.
relay = relay_registry.get("local")
response: RelayResponse = await relay.request(
    RelayRequest(method="GET", path="/health")
)

See the kiapi documentation for the full relay architecture.

License

MIT