caprid-relay
The Relay Python SDK. connect_relay_subscriber subscribes to track objects and
connect_relay_publisher publishes them, through Relay, Mux's Media over QUIC (MoQ) relay service.
Payloads are bytes the SDK does not interpret. You need no browser, player, or media catalog.
Requirements
- Python 3.11 or later, and asyncio.
- Network access to the relay over QUIC on UDP. The default transport is native QUIC (MOQT directly
on QUIC) through aioquic, which installs as a dependency. To use another transport, pass
create_transport. - A short-lived Relay JWT authorized for the namespace you use, and the endpoint of any relay other than the hosted one. The SDK uses tokens but does not issue them.
Install
uv add caprid-relay
pip install caprid-relay works too. It installs caprid-moq-core as a dependency. For media
publishing and reading, add caprid-moq-media.
Publish and subscribe
import asyncio
from caprid_relay import (
MoqtObject,
RelaySubscriptionHandlers,
connect_relay_publisher,
connect_relay_subscriber,
read_text,
)
async def main(token: str) -> None:
namespace = ["quickstart", "unique-run"] # relative to the token's root
arrived: asyncio.Future[str] = asyncio.get_running_loop().create_future()
def on_object(obj: MoqtObject) -> None:
if obj.status == "normal" and not arrived.done():
arrived.set_result(read_text(obj))
async with (
await connect_relay_publisher(namespace=namespace, get_token=lambda: token) as publisher,
await connect_relay_subscriber(get_token=lambda: token) as subscriber,
):
ticker = publisher.register_track("ticker")
await publisher.announced
subscription = subscriber.subscribe(namespace, "ticker", RelaySubscriptionHandlers(on_object=on_object))
await subscription.subscribed # a fresh namespace can briefly reject this with error 16; retry it
await ticker.write_text("hello from caprid-relay") # waits for the subscriber's demand
print(await arrived)
With no url, each connection dials the hosted Relay, https://relay.mux.global, with the token's
root as the path, so namespaces are relative to that root. Pass url first for another relay,
region or room; room_endpoint builds one.
The guide's full demo runs the complete version of this, with credential handling, the subscribe retry, a deadline, and cleanup on failure.
Stability
Before 1.0, a minor version can break the API, and
CHANGELOG.md says what changed.
caprid-relay, caprid-moq-core, and caprid-moq-media always release together at the same version,
and caprid-relay pins caprid-moq-core exactly. A release supports Python 3.11 or later, and MOQT
draft 22 (moqt-22) with draft 20 (moqt-20) as an offered fallback, against moq-relay 0.15.4 or
later.
Documentation
- Python guide: the quickstart, subscription and publishing lifecycles, async consumption, supervised connections, the aioquic transport, and the media examples.
- API reference: in a checkout of the repository, run
mise run python:docsto build it from the source. - Errors and recovery:
stable
RelayError.codeandphasevalues, the exception subclasses, preserved transport causes, and how to recover without assuming delivery or a safe replay. - Shared specification: the protocol pins, behavior contract, and test vectors every Relay SDK implements.
Metadata
Release files for caprid-relay 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| caprid_relay-0.3.0.tar.gz | 131.8 kB | With provenance | Details for caprid_relay-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| caprid_relay-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for caprid_relay-0.3.0-py3-none-any.whl |
Total release size: 285.5 kB
Release files / caprid_relay-0.3.0.tar.gz
| Download URL | caprid_relay-0.3.0.tar.gz |
|---|---|
| Size | 131.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ec61efa9b2bcc69f01dd0ee1d3f858adb63bb46bddb81c66301963c79d324318
|
|
BLAKE2b-256 checksum How to use checksums |
5e7bd2ab0ccc57606698d1387c8dd2a8152848bb90596213468ab205fd2bb03e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.
Transparency logRelease files / caprid_relay-0.3.0-py3-none-any.whl
| Download URL | caprid_relay-0.3.0-py3-none-any.whl |
|---|---|
| Size | 153.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3242716a128b42043241bacc71c3936cf3fdc9fed774df3d937c16a960007b15
|
|
BLAKE2b-256 checksum How to use checksums |
231a9d2ed2f0d2888143eb2a3b956a1cd9807b4911f3e5ba495075db4ac1fcae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.
Transparency logSecurity for caprid-relay 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for caprid_relay-0.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.