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.11.1.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

ypy_websocket-0.11.1-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ypy_websocket-0.11.1.tar.gz
  • Upload date:
  • Size: 15.2 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.11.1.tar.gz
Algorithm Hash digest
SHA256 e4a55c1e8cfd298e27bfccb3991f62b4f462afc4d3488ef5d717b1e76ea3d3b0
MD5 d4e6e82612e0783360381be4b15d3ebd
BLAKE2b-256 d7030e449152a33033262589ce83ca22811022e7e98393da7aa31f72c2ba8638

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for ypy_websocket-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2d6650c49dee5fce6c6fe2fc43993f75a45ff78785ac84bed7d2e33bab34ac0f
MD5 96cb32dbfb83a322ad483aedb59e1346
BLAKE2b-256 bce67f5ba913f03609b34bd635754cf520a185f7f24776825b464b0133249d54

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