Skip to main content

WebSocket connector for Ypy

Project description

Ypy-websocket

Ypy-websocket is an async WebSocket connector for Ypy.

Build Status Code style: black


Documentation: https://davidbrochart.github.io/ypy-websocket

Source Code: https://github.com/y-crdt/ypy-websocket


Ypy-websocket is a Python library for building WebSocket servers and clients that connect and synchronize shared documents. It can be used to create collaborative web applications.

The following diagram illustrates a typical architecture. The goal is to share a document among several clients.

Each client has an instance of a YDoc, representing their view of a document. A shared document also lives in a room on the server side. Conceptually, a room can be seen as the place where clients collaborate on a document. The WebSocket to which a client connects points to the corresponding room through the endpoint path. In the example below, clients A and B connect to a WebSocket at path room-1, and thus both clients find themselves in a room called room-1. All the YDoc synchronization logic is taken care of by the WebsocketProvider.

Each update to a shared document can be persisted to disk using a store, which can be a file or a database.

flowchart TD
    classDef room1 fill:#f96
    classDef room2 fill:#bbf
    A[Client A<br>room-1]:::room1 <-->|WebSocket<br>Provider| server(WebSocket Server)
    B[Client B<br>room-1]:::room1 <-->|WebSocket<br>Provider| server
    C[Client C<br>room-2]:::room2 <-->|WebSocket<br>Provider| server
    D[Client D<br>room-2]:::room2 <-->|WebSocket<br>Provider| server
    server <--> room1((room-1<br>clients: A, B)):::room1
    server <--> room2((room-2<br>clients: C, D)):::room2
    A <-..-> room1
    B <-..-> room1
    C <-..-> room2
    D <-..-> room2
    room1 ---> store1[(Store)]
    room2 ---> store2[(Store)]

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

ypy_websocket-0.12.1.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

ypy_websocket-0.12.1-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file ypy_websocket-0.12.1.tar.gz.

File metadata

  • Download URL: ypy_websocket-0.12.1.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for ypy_websocket-0.12.1.tar.gz
Algorithm Hash digest
SHA256 4169dc714ff592968ff7c2f4623045191d0cb1d3f40d0803e715c8a8b3acdde3
MD5 a7307934145dec5d6fdbef61a26cf653
BLAKE2b-256 8546d7c070b3d791cbf8ed16c1a3763c3eadf987fbb90959059662e5d8131639

See more details on using hashes here.

Provenance

File details

Details for the file ypy_websocket-0.12.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ypy_websocket-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf6f73ac4d6361f305c1ab6eead63292a5993228c94dda18d6c4997d5ef88b1c
MD5 ea857481a93bec9e1ee3cfde47530b85
BLAKE2b-256 e684959514cc1c0110b836602bf8fb68dfe5db0f9b7f4940a26ed564204517c8

See more details on using hashes here.

Provenance

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