1.1.0 • Published 3 years ago
jupyterlab_wipp v1.1.0
Jupyterlab WIPP extension
WIPP integration with JupyterLab
Requirements
- JupyterLab >= 3.0.0 (Old version is compatible with JupyterLab 2.x)
Install
pip install jupyterlab-wipp
jupyter serverextension enable --py jupyterlab_wipp
jupyter labextension install jupyterlab_wipp
export WIPP_UI_URL=""
export WIPP_API_INTERNAL_URL=""
export WIPP_NOTEBOOKS_PATH=""
The last three steps are required environment variables.
WIPP_UI_URL
is the WIPP frontend base URL which will be used to open collection pages.WIPP_API_INTERNAL_URL
is the internal URL of WIPP API (usually internal URL on Kubernetes cluster)WIPP_NOTEBOOKS_PATH
is the local path to WIPP'stemp/notebooks
folder
Contributing
Install
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
# Move to jupyterlab_wipp directory
# Install serverextension
pip install .
# Register serverextension
jupyter serverextension enable --py jupyterlab_wipp
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
Before starting the JupyterLab, the environment variable WIPP_UI_URL
must be set to point to WIPP.
Uninstall
jupyter labextension uninstall jupyterlab_wipp