Python bindings for the Y-Sweet server
Project description
y_sweet_sdk
Usage
from y_sweet_sdk import DocumentManager
# Get the websocket url for a document.
doc = DocumentManager('ys://localhost:8080')
url = doc.get_websocket_url('my-document-id')
# Connect to the document using y_py and ypy_websocket.
# (Based on: https://davidbrochart.github.io/ypy-websocket/usage/client/)
from ypy_websocket import WebsocketProvider
import y_py as Y
from websockets import connect
import asyncio
ydoc = Y.YDoc()
# Simple example: log the array "todolist" to stdout every time it changes.
data = ydoc.get_array("todolist")
def data_changed(event: Y.AfterTransactionEvent):
print(f"data changed: {data.to_json()}")
data.observe_deep(data_changed)
async with (
connect(url) as websocket,
WebsocketProvider(ydoc, websocket),
):
await asyncio.Future() # run forever
y_sweet_sdk
is only used to talk directly with the Y-Sweet server to obtain a WebSocket URL to pass to a client.
Use a Yjs client like ypy-websocket or pycrdt
in conjunction with y_sweet_sdk
to access the actual Y.Doc data.
Installation
For development installation with test dependencies:
pip install -e ".[dev]"
Tests
First run a y-sweet server:
npx y-sweet serve
Then run the tests:
pytest
Development
Run ruff format
to format before committing changes.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file y_sweet_sdk-0.5.1-py3-none-any.whl
.
File metadata
- Download URL: y_sweet_sdk-0.5.1-py3-none-any.whl
- Upload date:
- Size: 5.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f853991c98fde5e8111b2808cc2ec1170d557124a45f199bd40408471fd115bb |
|
MD5 | 75d642767f0bb8d39d96110b35d74232 |
|
BLAKE2b-256 | 46368c8eebacb823b4080afc2c9accadb0d25eca7c6a0fa304a5f19994d3aeee |