{"id":23919,"library":"jupyter-collaboration-ui","title":"jupyter-collaboration-ui","description":"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.","status":"active","version":"2.3.0","language":"python","source_language":"en","source_url":"https://github.com/jupyterlab/jupyter-collaboration/tree/main/packages/collaboration-extension","tags":["jupyterlab","collaboration","realtime","extension","ui"],"install":[{"cmd":"pip install jupyter-collaboration-ui","lang":"bash","label":"Stable"},{"cmd":"pip install jupyter-collaboration-ui==2.3.0","lang":"bash","label":"Pin version"}],"dependencies":[{"reason":"Core collaboration backend required for UI features","package":"jupyter-collaboration","optional":false},{"reason":"Required JupyterLab version >=4.0","package":"jupyterlab","optional":false}],"imports":[{"note":"ICollaborativeDrive is in jupyter-collaboration, not jupyter-collaboration-ui","wrong":"from jupyter_collaboration_ui import ICollaborativeDrive","symbol":"ICollaborativeDrive","correct":"from jupyter_collaboration import ICollaborativeDrive"}],"quickstart":{"code":"import jupyterlab\nimport jupyter_collaboration\n# Enable collaboration in JupyterLab config\nc = get_config()\nc.CollaborativeDrive = True","lang":"python","description":"JupyterLab collaboration UI is automatically enabled when jupyter-collaboration is installed. No direct import in user code."},"warnings":[{"fix":"Upgrade jupyter-collaboration: pip install -U jupyter-collaboration","message":"jupyter-collaboration-ui 2.x requires jupyter-collaboration >=3.0 (which uses pycrdt-websocket >=0.16). Older jupyter-collaboration versions are incompatible.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Install all packages in one environment: pip install jupyterlab jupyter-collaboration jupyter-collaboration-ui","message":"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.","severity":"gotcha","affected_versions":"all"},{"fix":"Enable collaboration UI in settings or add to jupyter_server_config.py: c.CollaborativeDrive.collaborative = True","message":"The 'Share' menu item in JupyterLab 4.0+ may be hidden by default. Enable via 'Settings > Advanced Settings Editor > Collaboration'.","severity":"deprecated","affected_versions":">=2.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"pip install jupyter-collaboration","cause":"Missing the core collaboration package.","error":"ModuleNotFoundError: No module named 'jupyter_collaboration'"},{"fix":"Upgrade both: pip install -U pycrdt-websocket jupyter-collaboration","cause":"Version mismatch between pycrdt-websocket and jupyter-collaboration packages.","error":"YDocDeserializer: Could not read document"},{"fix":"Run jupyter labextension install @jupyter/collaboration-extension or rebuild lab: jupyter lab build","cause":"Frontend extension not built or not properly installed.","error":"JupyterLab extension collaboration_ui is not enabled"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}