Skip to main content

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:docs to build it from the source.
  • Errors and recovery: stable RelayError.code and phase values, 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.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for caprid-relay 0.4.0
File Size Uploaded Provenance Actions
caprid_relay-0.4.0.tar.gz 136.6 kB With provenance Details for caprid_relay-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for caprid-relay 0.4.0
File Interpreter ABI Platform Actions
caprid_relay-0.4.0-py3-none-any.whl Python 3 none any Details for caprid_relay-0.4.0-py3-none-any.whl

Total release size: 296.0 kB

Release files / caprid_relay-0.4.0.tar.gz

Download URL caprid_relay-0.4.0.tar.gz
Size 136.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3c0a394c368a4dbbfec9e4c3ed35d79b3c8931d0a7dde99857a81ae71ce809ac
BLAKE2b-256 checksum
How to use checksums
9974666fb7cfd27b91d48b42b4e8e3f417e121416814e1fc84f6898a8df6ccd9
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 Nov 6, 2026.

Transparency log

Release files / caprid_relay-0.4.0-py3-none-any.whl

Download URL caprid_relay-0.4.0-py3-none-any.whl
Size 159.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9d5003ff6f8b3d9570e7b98f238711cfaf82d1b0c826465f43e6f816a60c2536
BLAKE2b-256 checksum
How to use checksums
7d2cf0fcfbe8ef65f655ff69e502fc996d846c7faf0609e2c481e4dafe63bfba
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 Nov 6, 2026.

Transparency log

Security for caprid-relay 0.4.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.

Select from 2 files

Attestation for caprid_relay-0.4.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 Nov 6, 2026.

Transparency log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page