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; no browser, player, or media catalog is needed.

Requirements

  • Python 3.11+ and asyncio.
  • The default transport is native QUIC (MOQT directly on QUIC) through aioquic, installed as a dependency. The endpoint and network must allow QUIC/UDP traffic. Other transports can be passed as create_transport.
  • A Relay endpoint and a short-lived Relay JWT authorized for the namespace you use. The SDK consumes tokens; it does not issue them.

Install

The package is unpublished and its name is provisional. Install it together with its local caprid-moq-core dependency from a checkout of this repository, as described in Use the local packages in your application.

Publish and subscribe

import asyncio

from caprid_relay import (
    MoqtObject,
    RelaySubscriptionHandlers,
    connect_relay_publisher,
    connect_relay_subscriber,
    read_text,
    room_endpoint,
)


async def main(token: str) -> None:
    url = room_endpoint("https://relay.mux.global", ["team"])  # your token's root as the path
    namespace = ["quickstart", "unique-run"]  # relative to that 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(url, namespace=namespace, get_token=lambda: token) as publisher,
        await connect_relay_subscriber(url, 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)

The guide's first round trip 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, the aioquic transport, and the Video.js media example.
  • API reference: run mise run python:docs to build it from the source.
  • Errors and recovery: stable RelayError.code and phase values, preserved exception subclasses and transport causes, and recovering without assuming delivery or safe replay.
  • Shared specification: the protocol pins, behavior contract, and test vectors every Relay SDK implements.

Metadata

Release files for caprid-relay 0.1.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.1.0
File Size Uploaded Provenance Actions
caprid_relay-0.1.0.tar.gz 126.6 kB With provenance Details for caprid_relay-0.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 274.8 kB

Release files / caprid_relay-0.1.0.tar.gz

Download URL caprid_relay-0.1.0.tar.gz
Size 126.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c8ece5928e0f0a798206d390efa57b6b3e17fad97517d240ad868f4192cc88b6
BLAKE2b-256 checksum
How to use checksums
635a9b0e836586018ec1b92513ee3c238414732c5e007cf853702dacee7b7e02
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 27, 2026.

Transparency log

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

Download URL caprid_relay-0.1.0-py3-none-any.whl
Size 148.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c2ca65b4c357deca019b14f320d08a720548929c3c4b19be56626a30a87de4da
BLAKE2b-256 checksum
How to use checksums
7abe53b0a215d4019a2ff8610c721237dbd64629ab02050788431d01ed7d8792
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 27, 2026.

Transparency log

Security for caprid-relay 0.1.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.1.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 27, 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