y-py

What it is and what it does

Ypy wraps the Rust-based Yrs library to bring Y-CRDT (Conflict-free Replicated Data Types) to Python. It enables multiple devices or processes to maintain synchronized shared state without a central authority, automatically resolving concurrent edits. The library models all data within a YDoc container and requires updates to happen inside transaction blocks, mirroring the design of Yjs (the JavaScript Y-CRDT binding). You can encode and apply state diffs to sync documents, making it suitable for collaborative editors, real-time applications, and distributed systems where eventual consistency is acceptable.

The package is a thin wrapper around Rust code, providing both safety and performance. It ships as pre-compiled wheels for Python 3.7–3.12 on Linux, macOS, and Windows. However, the project is archived and abandoned as of October 2023, with no active maintenance—the last commit was in April 2025 but the repository is marked archived, signaling that the maintainers are no longer actively developing it.

Use it for:

• Build collaborative text editors or note-taking apps where multiple users edit the same document simultaneously.
• Sync application state across browser and server in real-time without polling or manual conflict resolution.
• Implement distributed whiteboards or drawing applications with automatic convergence of concurrent strokes.
• Create offline-first mobile or desktop apps that merge local edits with remote changes when connectivity returns.
• Share structured data (arrays, maps, text) between Python services and JavaScript/TypeScript clients via Y-CRDT protocol.

Worth the install?

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

Ypy is a Python binding for Y-CRDT that provides distributed data types enabling real-time collaboration and state synchronization between devices through a transaction-based API.

Yes, if you need Y-CRDT in Python and can accept an abandoned codebase. The library is stable and has no known vulnerabilities, but expect no future updates, security patches, or API changes. Suitable for new projects only if you are comfortable maintaining a fork or migrating away if critical issues arise. For production systems requiring active maintenance, evaluate whether a maintained alternative or a different CRDT approach better fits your risk tolerance.

Install

y-py on PyPI

pip install y-py

uv add y-py

poetry add y-py

Installing y-py

Before you install

Medium install friction due to compiled Rust bindings; wheels are pre-built for common platforms (Python 3.7–3.12, Linux/macOS/Windows). However, the project is abandoned as of October 2023 with no recent maintenance, and the repository is archived—expect no bug fixes or updates.

License in practice

Licensed under MIT (permissive), allowing commercial and private use with minimal restrictions.

Quickstart

import y_py as Y

d1 = Y.YDoc()
text = d1.get_text('test')
with d1.begin_transaction() as txn:
    text.extend(txn, "hello world!")

d2 = Y.YDoc()
state_vector = Y.encode_state_vector(d2)
diff = Y.encode_state_as_update(d1, state_vector)
Y.apply_update(d2, diff)

Requires Python 3.7 or later; compiled wheels available for common architectures but not for all platforms (e.g., WASM/Pyodide wheels must be sourced from GitHub releases, not PyPI).

Verify before relying

• Whether the abandoned status and lack of updates since October 2023 affect compatibility with current Python or ecosystem changes.
• Performance characteristics and scalability limits for typical collaborative editing workloads.
• Interoperability guarantees with other Y-CRDT implementations across versions.

Package facts

Evidence: y_py-0.6.2-cp310-cp310-macosx_10_7_x86_64.whl; y_py-0.6.2-cp310-cp310-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl; y_py-0.6.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl; y_py-0.6.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl; y_py-0.6.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl; y_py-0.6.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl; y_py-0.6.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl; y_py-0.6.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl; y_py-0.6.2-cp310-none-win32.whl; y_py-0.6.2-cp310-none-win_amd64.whl; y_py-0.6.2-cp311-cp311-macosx_10_7_x86_64.whl; y_py-0.6.2-cp311-cp311-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl; y_py-0.6.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl; y_py-0.6.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl; y_py-0.6.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl; y_py-0.6.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl; y_py-0.6.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl; y_py-0.6.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl; y_py-0.6.2-cp311-none-win32.whl; y_py-0.6.2-cp311-none-win_amd64.whl

Keywords: crdt

Tags

More Distributed Computing packages