Skip to main content

stapel-video

CI coverage pypi downloads python license llms.txt

Video calls for the Stapel framework — a thin, provider-agnostic library over a real-time video backend (LiveKit by default).

  • Rooms with human-shareable join codes (abc-defg-hij).
  • Admission modelpublic (anyone with the code joins), scope_trusted (members of the room's scope join instantly, others wait), restricted (everyone but the host waits in a lobby).
  • Realtime lobby over WebSockets (Channels) — waiting / admitted / denied, authenticated by the same Stapel JWT stack HTTP uses.
  • Host controls — admit / deny waiting guests.
  • Provider seam — one VideoProvider ABC (mint join token, create room, start/stop recording egress, verify webhook). Swap vendors without forking.
  • Recording is a seam, not a pipeline: start/stop_egress proxy the provider and a video.egress_ended comm event carries the storage key to stapel-recordings — by event, never by import.

Alpha (0.1.0). See MODULE.md for the agent-facing map of seams.

Install

pip install stapel-video            # core library
pip install 'stapel-video[livekit]' # + the default LiveKit backend
pip install 'stapel-video[channels]'# + the realtime lobby (WebSockets)

Mount

# urls.py
path("video/", include("stapel_video.urls"))

# asgi.py (realtime lobby)
from channels.routing import ProtocolTypeRouter, URLRouter
from stapel_core.django.jwt.channels import JWTAuthMiddlewareStack
from stapel_video.routing import websocket_urlpatterns

application = ProtocolTypeRouter({
    "http": django_asgi_app,
    "websocket": JWTAuthMiddlewareStack(URLRouter(websocket_urlpatterns)),
})

API

Method Path What
POST /video/api/rooms Create a room (creator auto-admitted host, with a token)
GET /video/api/rooms/{join_code} Room info
POST /video/api/rooms/{join_code}/join Join → admitted / waiting / denied
GET /video/api/rooms/{join_code}/participants Participants (anchor-paginated)
POST /video/api/rooms/{join_code}/lobby/admit Admit a waiting guest (host-only)
POST /video/api/rooms/{join_code}/lobby/deny Deny a waiting guest (host-only)
POST /video/api/webhook Provider webhook ingress (signed, unauthenticated)

Configuration (STAPEL_VIDEO)

Key Default What
VIDEO_PROVIDER …livekit.LiveKitProvider Video backend (dotted path)
SCOPE_PROVIDER …scope.DefaultScopeProvider scope_key resolution + membership
DEFAULT_ACCESS_LEVEL restricted Access level for a room created without one
DEFAULT_ADMIT_REQUIRED True Whether new rooms start with the lobby on
LIVEKIT_URL / LIVEKIT_API_KEY / LIVEKIT_API_SECRET "" Default-provider credentials

VIDEO_PROVIDER, DEFAULT_ACCESS_LEVEL and DEFAULT_ADMIT_REQUIRED are the three CTO-facing config axes surfaced in docs/capabilities.json.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stapel_video-0.4.0.tar.gz (64.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stapel_video-0.4.0-py3-none-any.whl (63.4 kB view details)

Uploaded Python 3

File details

Details for the file stapel_video-0.4.0.tar.gz.

File metadata

  • Download URL: stapel_video-0.4.0.tar.gz
  • Upload date:
  • Size: 64.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for stapel_video-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a93b3f9215bed7f25b39d43b2ce8ec6823dfb88b6af6a6c98863a02251b0c3e7
MD5 82e5c3c7c0403b1ee253f21b28b45768
BLAKE2b-256 42b6573b448b3fae454e9adcea32b34f559119abbf70861d0aa8148c42b7d94c

See more details on using hashes here.

Provenance

The following attestation bundles were made for stapel_video-0.4.0.tar.gz:

Publisher: publish.yml on usestapel/stapel-video

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file stapel_video-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: stapel_video-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 63.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for stapel_video-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8976c872245caf3ad3e815d767289c854b611d30e82dc557d2f05c8705fadf6
MD5 3186269b8c36b6d22536a06c6d45d42a
BLAKE2b-256 a06b74d30036cd2a7c481d3ed593cf8aae58e56c7b8c52b4cb42f458a9b7f6bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for stapel_video-0.4.0-py3-none-any.whl:

Publisher: publish.yml on usestapel/stapel-video

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.11.2

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.1

2 files

This release

0.4.0 This release

2 files

0.3.0

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

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