Yjs sync protocol server for Django channels
Project description
Channels-Yroom
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.
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
Development
Project uses hatch
for the development workflow:
pip install hatch
hatch run +py=3.10 test:test
License
MIT
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)
Built Distribution
Close
Hashes for channels_yroom-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d15191025d99d80c52cf66de7a7c5909b003c7f48c92028b52677bc3f7aa5f2 |
|
MD5 | e687eab4ffa6e3e5e76cb9511bcc6a61 |
|
BLAKE2b-256 | 75016a30044ad291ef1164a6ac9eeb1f00c73cf5aaab482a0fe35001e583abeb |