{"id":23921,"library":"jupyter-collaboration","title":"Jupyter Collaboration","description":"Real-time collaboration extension for JupyterLab and Jupyter Notebook 7+. Metapackage bringing together server-side (pycrdt-websocket-based) and client-side collaboration components. Current version 4.3.0, released 2025-05-01. Monthly release cadence.","status":"active","version":"4.3.0","language":"python","source_language":"en","source_url":"https://github.com/jupyterlab/jupyter-collaboration/tree/main/projects/jupyter-collaboration","tags":["jupyter","collaboration","realtime","CRDT","metapackage"],"install":[{"cmd":"pip install jupyter-collaboration","lang":"bash","label":"pip"}],"dependencies":[{"reason":"Required for running the Jupyter server with collaboration enabled.","package":"jupyter_server","optional":false},{"reason":"Required for Notebook 7+ collaboration support.","package":"notebook","optional":true},{"reason":"CRDT WebSocket server and client for real-time sync.","package":"pycrdt-websocket","optional":false}],"imports":[{"note":"This is a metapackage; it only triggers extension activation. No public API is exported.","wrong":"from jupyter_collaboration import ...","symbol":"jupyter_collaboration","correct":"import jupyter_collaboration"}],"quickstart":{"code":"# Install and enable extensions\npip install jupyter-collaboration\n\n# Run JupyterLab with collaboration enabled\njupyter lab --collaborative\n","lang":"python","description":"Install the meta-package, then start JupyterLab with the --collaborative flag or enable the extension in the UI."},"warnings":[{"fix":"Do not attempt to import anything from this package in Python code. Use jupyter_server extension configuration or command-line flags.","message":"jupyter-collaboration is a metapackage; it does not expose any Python importable API. It only activates JupyterLab client extension and server extension.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade your environment: JupyterLab >=4.0.0, Python >=3.8.","message":"Version 4.x requires JupyterLab 4.x or Jupyter Notebook 7.x. It is not backward-compatible with JupyterLab 3.x.","severity":"breaking","affected_versions":">=4.0.0"},{"fix":"Enable the extension via jupyter labextension enable @jupyter/collaboration-extension or set jupyter_collaborative = True in jupyter_server_config.py.","message":"The --collaborative flag is deprecated in favor of enabling the collaboration extension in the Jupyter config or UI.","severity":"deprecated","affected_versions":">=4.0.0"},{"fix":"Ensure your proxy supports WebSocket upgrade (e.g., 'Upgrade' and 'Connection' headers).","message":"Real-time collaboration requires a WebSocket-capable proxy or direct connection. Behind reverse proxies (e.g., nginx), you must configure WebSocket upgrade headers.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run: pip install jupyter-collaboration","cause":"The metapackage is not installed, but may be listed as a dependency.","error":"ModuleNotFoundError: No module named 'jupyter_collaboration'"},{"fix":"Enable the server extension: jupyter server extension enable jupyter_collaboration or reinstall with pip.","cause":"The server extension is not enabled or the metapackage is missing.","error":"Extension @jupyter/collaboration-extension failed to load: unable to import 'jupyter_collaboration'"},{"fix":"Start JupyterLab with --collaborative flag or enable the extension in config. Check proxy for WebSocket support.","cause":"Jupyter server is not configured for collaboration, or WebSocket is blocked by proxy.","error":"ValueError: Could not find a WebSocket connection"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}