ypy-websocket

What it is and what it does

Ypy-websocket is a Python library that provides async WebSocket connectivity for Ypy, a CRDT implementation. It allows you to build collaborative applications where multiple clients connect to a shared document and synchronize changes in real time. The library manages the synchronization logic between client-side YDoc instances and server-side rooms, with optional persistence through a store abstraction.

The package is built on async/await patterns using anyio and aiosqlite, and integrates with y-py for the underlying CRDT operations. It handles the WebSocket protocol layer so you can focus on the collaboration logic. However, the project is now archived and abandoned, with its last release on 2023-10-04 and no active maintenance.

Use it for:

• Build a collaborative text editor or document editor where multiple users edit the same document simultaneously.
• Create a real-time whiteboard or drawing application with synchronized canvas state across clients.
• Implement a shared note-taking application where changes propagate instantly to all connected participants.
• Develop a collaborative code editor backend that syncs edits across multiple IDE instances.
• Build a multiplayer game or interactive application requiring real-time state synchronization.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Ypy-websocket is an async WebSocket connector for Ypy that enables building WebSocket servers and clients to synchronize shared documents across multiple clients in real time.

No, not for new projects. While the package itself is functional and has low install friction, it is abandoned (last release 2023-10-04, archived repository, no active maintenance). For collaborative document synchronization, you should evaluate actively maintained alternatives or fork this package if you need it. Existing projects already using it may continue, but new adoption carries maintenance risk.

Install

ypy-websocket on PyPI

pip install ypy-websocket

uv add ypy-websocket

poetry add ypy-websocket

Installing ypy-websocket

Before you install

Installation is straightforward with low friction. The package is abandoned as of its last commit on 2025-04-19, with no active maintenance; it has 52 stars and was last released on 2023-10-04. It depends on four runtime packages including y-py and anyio.

License in practice

MIT License permits free use, modification, and distribution with minimal restrictions. You may use this in proprietary projects and modify it as needed, provided you include the original copyright notice and license text.

Quickstart

pip install ypy-websocket

from ypy_websocket import WebsocketProvider
from y_py import YDoc

doc = YDoc()
provider = WebsocketProvider(doc, "ws://example.com/room")

Requires Python 3.7 or later; y-py and anyio must be installed as runtime dependencies.

Verify before relying

• Whether the abandoned status and 1045 days since last release pose practical risks for new projects.
• Whether the four runtime dependencies (aiosqlite, anyio, typing-extensions, y-py) are actively maintained.
• Whether this package is still suitable for production use given its Beta development status and lack of recent updates.

Package facts

Evidence: ypy_websocket-0.12.4-py3-none-any.whl

Keywords: websocket, yjs

Tags

More WWW/HTTP packages