jupyterlab-nb-viz

A JupyterLab extension.

Requirements

JupyterLab >= 3.0
Reactflow
Dagre.js
Node.js >= 16.*
Cookicutter
Git

Environment Setup Guide (for Enmeng)

Based on the guide in https://jupyterlab.readthedocs.io/en/latest/extension/extension_tutorial.html#extension-tutorial to set up env
Specific versions of Python and Node.js are required

# Step 1: clone this repo

# Step 2: Create a conda env (NOTE: this is different from the tutorial so reference this as source of truth)
conda create -n nb-viz --override-channels --strict-channel-priority -c conda-forge -c nodefaults python=3.10 jupyterlab=3 cookiecutter nodejs=16.6.1 jupyter-packaging git

# Install dependencies
pip install -ve .
# use the `develop` command to create a symbolic link from JupyterLab to our source directory. This means our changes are automatically available in JupyterLab
jupyter labextension develop --overwrite .


# Step 3: Intall additional dependencies
# use jlpm (jupyter version of package manager) to add dependencies
jlpm add @jupyterlab/apputils
jlpm add @jupyterlab/application
jlpm add @lumino/widgets
## ui-components are used for creating ReactWidget from react component
jlpm add @jupyterlab/ui-components
# add dependencies for reactflow and autolayout (dagre)
jlpm add reactflow
jlpm add dagre
# for dagre.js to work in TypeScript
jlpm add @types/dagre

# Try build (the build will likely fail, move on to see additional change to reactflow source code)
jlpm build

# see additional change to reactflow source code to make build work
# after build success run and invoke command prompt by ctrl+shift+c then enter "reactflow"
jlpm build
jupyter lab

Additional change to reactflow source code to make jlpm build
- error 1: ResizeObserver not find - temp solution
- error 2: Generic type 'PropsWithChildren' requires 1 type argument(s). - temp solution
  - Added <{foo: string}> as a type argument (have no idea why it works)
  - declare const ReactFlowProvider: FC<PropsWithChildren<{foo: string}>>;
- error3: type is undefined
  - Solution - Remove all type keywords
To start developing
- Run jlpm build every time make changes to the sources code
- Refresh the Jupyter Lab client
- See the change and debug

Install

To install the extension, execute:

pip install jupyterlab-nb-viz

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-nb-viz

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-nb-viz directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall jupyterlab-nb-viz

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyterlab-nb-viz within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE

yixin0829/jupyterlab-nb-viz