channels-webtransport
Experimental WebTransport support for Django Channels, backed by PyWebTransport.
This is deliberately a thin package: it translates a PyWebTransport session into a small, versioned ASGI extension and provides a Channels-style async consumer. It is suitable for experimentation and internal projects while the WebTransport ASGI protocol is still being designed. It is not yet a stable public protocol.
Install
The package requires Python 3.12 or newer.
uv add channels-webtransport
For a local checkout:
uv add --editable ../channels-webtransport
Configure Django
Add the package to INSTALLED_APPS so Django discovers the management command:
INSTALLED_APPS = [
# ...
"channels",
"channels_webtransport",
]
ASGI_APPLICATION = "project.asgi.application"
WEBTRANSPORT = {
"HOST": "127.0.0.1",
"PORT": 4433,
"CERTFILE": BASE_DIR / "certs" / "localhost.crt",
"KEYFILE": BASE_DIR / "certs" / "localhost.key",
# Any remaining PyWebTransport ServerConfig keyword arguments:
"OPTIONS": {},
}
The same root ASGI application can route HTTP, WebSocket, and WebTransport scopes:
# project/asgi.py
import os
from channels.routing import ProtocolTypeRouter, URLRouter
from django.core.asgi import get_asgi_application
from django.urls import path
from app.consumers import EchoWebTransportConsumer
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")
application = ProtocolTypeRouter(
{
"http": get_asgi_application(),
"webtransport": URLRouter([path("wt/echo/", EchoWebTransportConsumer.as_asgi())]),
}
)
Create a consumer in the usual Channels style:
# app/consumers.py
from channels_webtransport import AsyncWebTransportConsumer
class EchoWebTransportConsumer(AsyncWebTransportConsumer):
async def receive_datagram(self, data: bytes) -> None:
await self.send_datagram(data)
async def receive_stream(self, stream: int, data: bytes, end_stream: bool) -> None:
await self.send_stream(stream, data, end_stream=end_stream)
Then run the WebTransport listener alongside the normal HTTP/ASGI server:
uv run python manage.py runwebtransport
runwebtransport owns a separate HTTP/3-over-UDP listener. Your normal Daphne/Uvicorn
process continues to serve HTTP and WebSocket traffic. Command-line flags override settings:
uv run python manage.py runwebtransport \
--host 127.0.0.1 --port 4433 \
--certificate certs/localhost.crt --private-key certs/localhost.key
Local TLS and browser testing
WebTransport requires HTTPS and HTTP/3. Generate a short-lived development certificate with PyWebTransport:
mkdir -p certs
uv run python -c \
'from pywebtransport.utils import generate_self_signed_cert; generate_self_signed_cert(hostname="localhost", output_dir="certs", validity_days=13)'
For a Python client, pass ssl.CERT_NONE only in local tests. Browsers require the SHA-256
certificate hash in serverCertificateHashes for a self-signed certificate, and the certificate
must be valid for no more than 14 days. Chromium-based browsers have the broadest development
support. See examples/browser_echo.html for a client.
Serve the example from localhost, paste the certificate hash into it, and open
http://localhost:8000/browser_echo.html:
uv run python -m http.server --directory examples 8000
Consumer test helper
Most consumer logic can be tested without opening a UDP socket:
from channels_webtransport.testing import WebTransportCommunicator
async def test_echo():
communicator = WebTransportCommunicator(EchoWebTransportConsumer.as_asgi(), "/wt/echo/")
connected, _ = await communicator.connect()
assert connected
await communicator.send_datagram(b"hello")
assert await communicator.receive_datagram() == b"hello"
await communicator.disconnect()
The package test suite also starts a real loopback QUIC server and client:
uv run pytest
Experimental ASGI contract
The scope has type="webtransport", ordinary HTTP request fields, and
scope["webtransport"]["spec_version"] == "0.1".
Messages received by the application:
webtransport.connectwebtransport.datagram.receivewithdatawebtransport.stream.openwithstream,direction, andinitiated_bywebtransport.stream.receivewithstream,data, andend_streamwebtransport.stream.resetandwebtransport.stream.stop_sendingwebtransport.disconnectwithcodeandreason
Messages sent by the application:
webtransport.accept, optionally withsubprotocolwebtransport.close, with sessioncode/reason, or pre-accept HTTPstatuswebtransport.datagram.sendwithdatawebtransport.stream.sendwithstream,data, andend_streamwebtransport.stream.resetandwebtransport.stream.stop_receiving
Version 0.1 supports datagrams and client-created bidirectional and unidirectional streams. Server-created streams, a synchronous consumer, and a standardized ASGI extension are outside this first release. HTTP middleware that expects an HTTP scope will not automatically apply; authenticate the CONNECT request using the WebTransport scope headers or a short-lived ticket.
Development
uv sync --all-groups
uv run ruff check .
uv run mypy
uv run pytest
uv build
Licensed under the MIT License.
Metadata
Release files for channels-webtransport 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| channels_webtransport-0.0.1.tar.gz | 10.2 kB | With provenance | Details for channels_webtransport-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| channels_webtransport-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for channels_webtransport-0.0.1-py3-none-any.whl |
Total release size: 24.1 kB
Release files / channels_webtransport-0.0.1.tar.gz
| Download URL | channels_webtransport-0.0.1.tar.gz |
|---|---|
| Size | 10.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
34cdf7a0cf7fea468abd9bac065e9de586f5d39afcd5119d3e9a970bd217df76
|
|
BLAKE2b-256 checksum How to use checksums |
c8a04e3361c7b9d09c5d089089e82043413d207703de08ec49a11c9182323579
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 15, 2026.
Transparency logRelease files / channels_webtransport-0.0.1-py3-none-any.whl
| Download URL | channels_webtransport-0.0.1-py3-none-any.whl |
|---|---|
| Size | 13.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8cb828fcb65c691906bb00eff353e3d4eacda42c1f47515216d8adee709fbcff
|
|
BLAKE2b-256 checksum How to use checksums |
092dd2474ce6b7e90dac6549b5eda6e7966ad3433df23da63e6fbee52ca24126
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 15, 2026.
Transparency logSecurity for channels-webtransport 0.0.1
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.
Attestation for channels_webtransport-0.0.1.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 Aug 15, 2026.
Transparency logA 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.