stapel-video

Video calls: rooms with shareable join codes, an access-level admission model (public / scope-trusted / restricted lobby) with a realtime waiting room over WebSockets, host admit/deny controls, join-token minting through a pluggable video-provider seam (LiveKit by default), and a recording-egress seam (start/stop + a video.egress_ended event) that integrates with stapel-recordings by event, never by import.

Part of the Stapel framework — composable Django apps that deploy as a monolith or as microservices without changing module code.

Install

pip install stapel-video

At a glance

Fact	Value
Version	`0.5.0`
Python	`>=3.11` (3.11, 3.12, 3.13, 3.14)
HTTP operations	7
Config axes	3
Usage surface	11
Extension points	4
Error codes	49
Fleet dependencies	`stapel-auth` (optional) · `stapel-core` · `stapel-profiles` (optional) · `stapel-recordings` (optional)

Documentation

OpenAPI · capabilities.json · llms.txt (for agents)

What this is

Rooms with human-shareable join codes (abc-defg-hij).
Admission model — public (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. See MODULE.md for the agent-facing map of seams.

Quick start

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

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

License

MIT — see LICENSE.

_{This page is assembled by stapel-readme from docs/readme.md plus the contract artifacts in docs/. Edit the prose in docs/readme.md; the badges, facts and links above and below it are generated — do not hand-edit README.md.}

Development Status
- 3 - Alpha
Framework
- Django
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
Typing
- Typed

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.5.0.tar.gz (69.7 kB view details)

Uploaded Aug 16, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

stapel_video-0.5.0-py3-none-any.whl (65.6 kB view details)

Uploaded Aug 16, 2026 Python 3

File details

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

File metadata

Download URL: stapel_video-0.5.0.tar.gz
Upload date: Aug 16, 2026
Size: 69.7 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.5.0.tar.gz
Algorithm	Hash digest
SHA256	`635e8ed4f194c4dee439c5d32e4f0ee23b22c896be2a6fdfd281bc898f49ed87`
MD5	`1c52ed9972c35f7e8b88413514f20b3b`
BLAKE2b-256	`6d3abd95900b8f28277a8249b6f0aca429e24c3be38ff982e63b381cabb4e496`

See more details on using hashes here.

Provenance

The following attestation bundles were made for stapel_video-0.5.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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: stapel_video-0.5.0.tar.gz
- Subject digest: 635e8ed4f194c4dee439c5d32e4f0ee23b22c896be2a6fdfd281bc898f49ed87
- Sigstore transparency entry: 2482856765
- Sigstore integration time: Aug 16, 2026
Source repository:
- Permalink: usestapel/stapel-video@4d57b29c42a4e435e13f560ce1a94ddf80504b16
- Branch / Tag: refs/tags/v0.5.0
- Owner: https://github.com/usestapel
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@4d57b29c42a4e435e13f560ce1a94ddf80504b16
- Trigger Event: push