jupyter-collaboration-ui

2.3.0 verified Fri May 01 auth: no python

JupyterLab extension providing a user interface for real-time collaboration, including cursor positions, selections, and chat. Current version: 2.3.0 (PyPI) / 4.3.0 (npm). Release cadence: quarterly.

pip install jupyter-collaboration-ui

Common errors

error ModuleNotFoundError: No module named 'jupyter_collaboration' ↓

cause Missing the core collaboration package.

fix

pip install jupyter-collaboration

error YDocDeserializer: Could not read document ↓

cause Version mismatch between pycrdt-websocket and jupyter-collaboration packages.

fix

Upgrade both: pip install -U pycrdt-websocket jupyter-collaboration

error JupyterLab extension collaboration_ui is not enabled ↓

cause Frontend extension not built or not properly installed.

fix

Run jupyter labextension install @jupyter/collaboration-extension or rebuild lab: jupyter lab build

Warnings

breaking jupyter-collaboration-ui 2.x requires jupyter-collaboration >=3.0 (which uses pycrdt-websocket >=0.16). Older jupyter-collaboration versions are incompatible. ↓

fix Upgrade jupyter-collaboration: pip install -U jupyter-collaboration

gotcha jupyter-collaboration-ui is a server extension and must be installed in the same environment as JupyterLab. Using separate environments (e.g., conda envs) for frontend and backend will break collaboration. ↓

fix Install all packages in one environment: pip install jupyterlab jupyter-collaboration jupyter-collaboration-ui

deprecated The 'Share' menu item in JupyterLab 4.0+ may be hidden by default. Enable via 'Settings > Advanced Settings Editor > Collaboration'. ↓

fix Enable collaboration UI in settings or add to jupyter_server_config.py: c.CollaborativeDrive.collaborative = True

Install

pip install jupyter-collaboration-ui==2.3.0

Imports

ICollaborativeDrive

wrong

from jupyter_collaboration_ui import ICollaborativeDrive

correct

from jupyter_collaboration import ICollaborativeDrive

ICollaborativeDrive is in jupyter-collaboration, not jupyter-collaboration-ui

Quickstart

JupyterLab collaboration UI is automatically enabled when jupyter-collaboration is installed. No direct import in user code.

import jupyterlab
import jupyter_collaboration
# Enable collaboration in JupyterLab config
c = get_config()
c.CollaborativeDrive = True