JupyterLab Open Warning

JupyterLab extension to display a warning dialog when opening a file that another user has open.

Installation

Install the latest version of JupyterLab Open Warning using pip:

pip install -U jupyterlab-open-warning

This extension should run alongside JupyterLab version 4 and the JupyterLab Real-Time Collaboration extension.

To automatically install along with Real-Time Collaboration, use the rtc extra:

pip install -U "jupyterlab-open-warning[rtc]"

While the Real-Time Collaboration extension is required in order to display open warning dialogs, the collaboration functionality can be disabled by running JupyterLab with the following option:

jupyter lab --YDocExtension.disable_rtc True

Development

To develop, the following dependencies must be installed:

• Python
• Hatch
• Node.js

To build the extension and start up a JupyterLab server for development, run:

hatch run dev

When the source code changes, the extension should be automatically rebuilt, and the updated extension will be used when the page is reloaded.

Note

On Windows, symbolic links must be activated for hatch run dev to work. On Windows 10 or above, this can be done by activating developer mode.

Alternatively, you can run

hatch run clean
hatch env remove default
hatch run jupyter lab

to completely reinstall the extension and start JupyterLab each time the source code changes.