https://github.com/stefanw/yroom

High-level Python bindings to Rust yjs/y-crdt sync+awareness API
https://github.com/stefanw/yroom

crdt python yjs

Last synced: 8 months ago
JSON representation

High-level Python bindings to Rust yjs/y-crdt sync+awareness API

• Host: GitHub
• URL: https://github.com/stefanw/yroom
• Owner: stefanw
• License: mit
• Created: 2023-03-21T09:43:56.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-27T19:54:29.000Z (over 2 years ago)
• Last Synced: 2025-03-23T23:34:10.659Z (about 1 year ago)
• Topics: crdt, python, yjs
• Language: Rust
• Homepage:
• Size: 79.1 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![PyPI version](https://badge.fury.io/py/yroom.svg)](https://badge.fury.io/py/yroom)

# Yroom

Python API to synchronize clients and distribute updates via the Yjs protocol. It's written in Rust and uses [Yrs](https://github.com/y-crdt/y-crdt) and [y-sync](https://github.com/y-crdt/y-sync).

It was built for [channels-yroom](https://github.com/stefanw/channels-yroom).

## Installation

```

pip install yroom

```

## API

See `yroom.pyi`.

## Development

[Maturin](https://www.maturin.rs) can be used to build `Yroom` inside a virtual environment.

```

maturin develop

```