---
id: jupyter-server-ydoc
version: "3.0.0"
license: # Licensing terms This project is licensed under the terms of the Modified BSD License (also known as New or Revised or 3-Clause BSD), as follows: - Copyright (c) 2021-, Jupyter Development Team All… (full text in the JSON record)
license_treatment: permissive
maintenance: active
---

# jupyter-server-ydoc — jupyter-server extension integrating collaborative shared models.

License: permissive · Maintenance: active · Downloads: 1.5M/mo

## What it is and what it does

jupyter-server-ydoc is a Jupyter Server extension that integrates Y documents (a CRDT-based collaborative data structure) to enable real-time multi-user editing in JupyterLab. It sits between the Jupyter Server and JupyterLab clients, synchronizing changes across connected users through pycrdt and pycrdt-websocket for transport.

The package handles the server-side coordination of shared document state, allowing multiple users to edit the same notebook or file simultaneously with live updates. It depends on jupyter-server, jupyter-ydoc, jsonschema, jupyter-events, jupyter-server-fileid, pycrdt, and pycrdt-websocket to manage document synchronization, event routing, and file identity tracking.

Use it for:

- Enable live collaborative notebook editing for teams working on the same analysis or code in real time.
- Support classroom or workshop environments where an instructor and students edit shared notebooks together.
- Facilitate pair programming and code review sessions within JupyterLab without manual file synchronization.
- Build shared research or data science workflows where multiple analysts need to work on the same notebook concurrently.
- Implement document-level conflict resolution and undo/redo that respects concurrent edits from multiple users.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Adds real-time collaborative editing to Jupyter Server and JupyterLab through Y document integration, enabling multiple users to edit notebooks and files simultaneously.

Yes, if you need real-time multi-user editing in Jupyter. The package is actively maintained, has low install friction, carries a permissive BSD license, and has no known vulnerabilities. It is a purpose-built extension for Jupyter Server with stable dependencies. Install it only if your Jupyter deployment requires collaborative editing; it is not useful as a standalone library.

## Install

pip install jupyter-server-ydoc
uv add jupyter-server-ydoc
poetry add jupyter-server-ydoc

## Installing jupyter-server-ydoc

Before you install: Low friction install with active maintenance. Released 11 days ago with recent commits. Depends on 7 runtime packages including jupyter-server, pycrdt, and pycrdt-websocket for collaboration infrastructure.

License in practice: Modified BSD License (3-Clause) is permissive and imposes no restrictions on commercial or proprietary use, only requiring preservation of copyright and license notices in distributions.

Quickstart:

pip install jupyter-server-ydoc

from jupyter_server_ydoc import YDocExtension
# Extension is loaded automatically by Jupyter Server when installed

Requires Python 3.10 or later; intended as a Jupyter Server extension, not standalone library code.

Verify before relying:

- Whether this package alone enables collaboration or requires additional JupyterLab frontend extensions to be installed separately.
- Performance characteristics and scalability limits for concurrent users in a shared session.
- Whether pycrdt-websocket is the only supported transport or if other backends are available.

## Package facts

- License: # Licensing terms This project is licensed under the terms of the Modified BSD License (also known as New or Revised or 3-Clause BSD), as follows: - Copyright (c) 2021-, Jupyter Development Team All… (full text in the JSON record) (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 1.5M/month (top 5,000 on PyPI)
- Known vulnerabilities: none known

## Tags

jupyter real-time collaboration, collaborative notebook editing, jupyter shared documents, multi-user jupyter editing, jupyter ydoc integration, jupyter server extension collaboration, live notebook synchronization, jupyter-extension, real-time-collaboration, crdt

[View on SkillFed](https://skillfed.io/packages/jupyter-server-ydoc) · [View on PyPI](https://pypi.org/project/jupyter-server-ydoc/)