nbdefense_jupyter 1.0.2

NB Defense Jupyter Lab Extension

nbdefense_jupyter

The NBDefense Jupyter extension

This extension is composed of a Python package named nbdefense_jupyter for the server extension and a NPM package named nbdefense-jupyter for the frontend extension.

Requirements

• JupyterLab >= 3.0

Install

To install the extension, execute:

pip install nbdefense_jupyter

If you are planning on using the PII module you will need to install en_core_web_trf

python -m spacy download en_core_web_trf

Enable the extension

jupyter server extension enable nbdefense_jupyter

Start (or restart) the Jupyter Lab Server

jupyter lab

Uninstall

To remove the extension, execute:

pip uninstall nbdefense_jupyter

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

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 nbdefense_jupyter directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable nbdefense_jupyter
# 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

# Server extension must be manually disabled in develop mode
jupyter server extension disable nbdefense_jupyter
pip uninstall nbdefense_jupyter

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 nbdefense-jupyter within that folder.

Updating the nbdefense dependency

Note: We should automate this process in the future

1. Download the new release's wheel file from the S3 bucket
2. Rename the release to follow this format: nbdefense-{VERSION}-py2.py3-none-any.whl
3. Copy the file to the nbdefense_cli directory
4. Update the dependency in the pyproject.toml file to match the new filename
5. Re-run pip install -e .