jupyter_server_ydoc_room_and_yunicode_sync_quickstart.py

1import asyncio
2from jupyter_server_ydoc.app import YDocExtension
3from jupyter_server_ydoc.rooms import Room
4from ypy_websocket import YDoc
5
6async def main():
7    # Initialize a Y-document (the shared state)
8    ydoc = YDoc()
9    
10    # Create a Room, which is the core object jupyter-server-ydoc 
11    # uses to manage shared documents in a Jupyter Server context.
12    # In a real server, the room_name is usually the file path.
13    room_name = "test_room"
14    room = Room(room_name, ydoc)
15    
16    # Example: Accessing the underlying Y-text object 
17    # Jupyter typically uses 'source' for the main content of a document
18    with ydoc.begin_transaction() as t:
19        text = ydoc.get_text("source")
20        text.extend(t, "Hello, Jupyter Collaboration!")
21
22    print(f"Room '{room.room_name}' initialized.")
23    print(f"Content: {str(ydoc.get_text('source'))}")
24
25if __name__ == "__main__":
26    asyncio.run(main())