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
1 maintainer
Release files for channels-yroom 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| channels_yroom-0.0.6.tar.gz | 74.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| channels_yroom-0.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 87.3 kB
Release files / channels_yroom-0.0.6.tar.gz
| Download URL | channels_yroom-0.0.6.tar.gz |
|---|---|
| Size | 74.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fd585ff71ce553236d3d1e54b7339d7ee9ecbe21433f9c5a170cb40d06cc7a0c
|
|
BLAKE2b-256 checksum How to use checksums |
7dab073ebfb2e35a82886e2cb86e2eb80de1ca9b2ebd521317f2dbe291b56fa1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.24.0
|
Release files / channels_yroom-0.0.6-py3-none-any.whl
| Download URL | channels_yroom-0.0.6-py3-none-any.whl |
|---|---|
| Size | 13.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d15191025d99d80c52cf66de7a7c5909b003c7f48c92028b52677bc3f7aa5f2
|
|
BLAKE2b-256 checksum How to use checksums |
75016a30044ad291ef1164a6ac9eeb1f00c73cf5aaab482a0fe35001e583abeb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.24.0
|
