https://github.com/jupyterlab/jupyter-collaboration

A Jupyter Server Extension Providing Support for Y Documents
https://github.com/jupyterlab/jupyter-collaboration

jupyter jupyterlab jupyterlab-extension python real-time-collaboration rtc

Last synced: 8 days ago
JSON representation

A Jupyter Server Extension Providing Support for Y Documents

• Host: GitHub
• URL: https://github.com/jupyterlab/jupyter-collaboration
• Owner: jupyterlab
• License: other
• Created: 2022-07-10T08:30:52.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-04T10:56:19.000Z (18 days ago)
• Last Synced: 2025-04-07T02:08:14.751Z (16 days ago)
• Topics: jupyter, jupyterlab, jupyterlab-extension, python, real-time-collaboration, rtc
• Language: Jupyter Notebook
• Homepage: https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/
• Size: 8.51 MB
• Stars: 202
• Watchers: 18
• Forks: 36
• Open Issues: 90
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jupyter Real-Time Collaboration

[![Build Status](https://github.com/jupyterlab/jupyter_collaboration/actions/workflows/test.yml/badge.svg?query=branch%3Amain++)](https://github.com/jupyterlab/jupyter_collaboration/actions?query=branch%3Amain++)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyter_collaboration/main)

[![PyPI](https://img.shields.io/pypi/v/jupyter-collaboration)](https://pypi.org/project/jupyter-collaboration)

[![npm](https://img.shields.io/npm/v/@jupyter/collaboration-extension)](https://www.npmjs.com/package/@jupyter/collaboration-extension)

JupyterLab Real-Time Collaboration is a Jupyter Server Extension and JupyterLab extensions providing support for [Y documents](https://github.com/jupyter-server/jupyter_ydoc) and adding collaboration UI elements in JupyterLab.

![Real-Time Collaboration Demonstration](./docs/source/images/rtc_shared_cursors.png)

## Installation and Basic usage

To install the latest release locally, make sure you have

[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:

```bash

pip install jupyter-collaboration

```

Or using ``conda``/``mamba``:

```bash

conda install -c conda-forge jupyter-collaboration

```

### Testing

See [CONTRIBUTING](./docs/source/developer/contributing.rst#running-tests).

## Contributing

If you are interested in contributing to the project, see [CONTRIBUTING](./docs/source/developer/contributing.rst).