stapel-video
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 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
VideoProviderABC (mint join token, create room, start/stop recording egress, verify webhook). Swap vendors without forking. - Recording is a seam, not a pipeline:
start/stop_egressproxy the provider and avideo.egress_endedcomm 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.
1 maintainer
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.3.0.tar.gz
(54.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file stapel_video-0.3.0.tar.gz.
File metadata
- Download URL: stapel_video-0.3.0.tar.gz
- Upload date:
- Size: 54.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0f495ff27a5529f60b6b41e1249cadd46aba817759abbc5f5d26809accefe1ac
|
|
| MD5 |
1de9ada0b6c3a98bfc197153220ba321
|
|
| BLAKE2b-256 |
3e97ffac2885c0026035fb257b0c063eb517cd8922f886764decff94df19c77e
|
Provenance
The following attestation bundles were made for stapel_video-0.3.0.tar.gz:
Publisher:
publish.yml on usestapel/stapel-video
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
stapel_video-0.3.0.tar.gz -
Subject digest:
0f495ff27a5529f60b6b41e1249cadd46aba817759abbc5f5d26809accefe1ac - Sigstore transparency entry: 2396419268
- Sigstore integration time:
-
Permalink:
usestapel/stapel-video@71c68cccdd89faff6be6f1772e0450655da28d34 -
Branch / Tag:
refs/tags/v0.3.0 - Owner: https://github.com/usestapel
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@71c68cccdd89faff6be6f1772e0450655da28d34 -
Trigger Event:
push
-
Statement type:
File details
Details for the file stapel_video-0.3.0-py3-none-any.whl.
File metadata
- Download URL: stapel_video-0.3.0-py3-none-any.whl
- Upload date:
- Size: 55.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
06d9a4ce213f62fed77534756e569e8cc1785b3492c525a0d85a8ba20dffde64
|
|
| MD5 |
76cdbc48816979c225b652f02b7af92a
|
|
| BLAKE2b-256 |
9f3bae53319a52f89ba18a350583ad64c27e764ba06008ba443a4b374a82002b
|
Provenance
The following attestation bundles were made for stapel_video-0.3.0-py3-none-any.whl:
Publisher:
publish.yml on usestapel/stapel-video
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
stapel_video-0.3.0-py3-none-any.whl -
Subject digest:
06d9a4ce213f62fed77534756e569e8cc1785b3492c525a0d85a8ba20dffde64 - Sigstore transparency entry: 2396419761
- Sigstore integration time:
-
Permalink:
usestapel/stapel-video@71c68cccdd89faff6be6f1772e0450655da28d34 -
Branch / Tag:
refs/tags/v0.3.0 - Owner: https://github.com/usestapel
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@71c68cccdd89faff6be6f1772e0450655da28d34 -
Trigger Event:
push
-
Statement type:
