Skip to main content

Yjs sync protocol server for Django channels

Project description



channels-yroom is a Django Channels WebSocket consumer and worker for synchronizing Yjs clients. It implements the network protocol for Yjs doc synchronization and awareness updates and makes them available as Django Channels WebSocket consumer and worker.


Read the documentation

Showcase: text collaboration example

The example folder contains a simple project that uses y-prosemirror to allow for realtime collaboration on rich text.

Run the included Docker compose file to check it out:

docker compose up
# Then visit localhost:8000


Project uses hatch for the development workflow:

pip install hatch

hatch run +py=3.10 test:test



Project details

Download files

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

Source Distribution

channels_yroom-0.0.6.tar.gz (74.0 kB view hashes)

Uploaded Source

Built Distribution

channels_yroom-0.0.6-py3-none-any.whl (13.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page