MAAP Help Jupyter Extension

Jupyter extension that provides an interactive tour and adds MAAP specific information to the help tab

Requirements

Package	Version
JupyterLab	v4.1.6
NodeJS	v18.20.0
Python	>= v3.8

These are the recommended versions. Others may be suitable, but are not actively supported.

Install

To install the extension, execute:

pip install maap_help_jupyter_extension

Uninstall

To remove the extension, execute:

pip uninstall maap_help_jupyter_extension

Contributing

Development install

# Install package dependencies
jlpm install
# 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 run build

If you would like to disable the default jupyter lab tutorial, (MAAP specific one will still be enabled), run

jupyter labextension disable "jupyterlab-tour:default-tours"

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.

The first command installs the dependencies that are specified in the setup.py file and in package.json. Among the dependencies are also all the JupyterLab components that you want to use in your project.

It then runs the build script. In that step, the TypeScript code gets converted to javascript using the compiler tsc and stored in a lib directory. And a condensed form of the Javascript is copied in the Python package (in the folder maap_help_jupyter_extension/labextension). This is the code that would be installed by the user in JupyterLab.

The second command creates a symbolic link to the folder maap_help_jupyter_extension/labextension so that extension is installed in development mode in JupyterLab.

The third command allows you to update the Javascript code each time you modify your extension code.

Now, we can run the extension. Note by adding --watch, we just have to refresh the browser when the project is rebuilt.

jupyter lab --watch

Development uninstall

pip uninstall maap_help_jupyter_extension

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 maap-help-jupyter-extension within that folder.

Testing

Playwright is the testing framework used. When testing locally, use the following command to start the jupyter server and run the tests:

jlpm run start & jlpm run test

To test using the interactive UI, run the following instead:

jlpm run start & jlpm run test --ui

File Structure Info

Information about the extension:
- README.md contains some instructions
- LICENSE contains your extension code license; BSD-3 Clause by default (but you can change it).
Extension code (those files are mandatory):
- package.json contains information about the extension such as dependencies
- tsconfig.json contains information for the typescript compilation
- src/plugin.ts this contains the actual code of your extension
- style/ folder contains style elements that you can use
Validation:
- .prettierrc and .prettierignore specify the code formatter prettier configuration
- .eslintrc.js and .eslintignore specify the code linter eslint configuration
- .github/workflows/build.yml sets the continuous integration tests of the code using GitHub Actions
Packaging as a Python package:
- setup.py contains information about the Python package such as what to package
- pyproject.toml contains the dependencies to create the Python package
- MANIFEST.in contains list of non-Python files to include in the Python package
- install.json contains information retrieved by JupyterLab to help users know how to manage the package
- maap_help_jupyter_extension folder contains the final code to be distributed
Release

See RELEASE

Contribute

See CONTRIBUTING

MAAP-Project/maap-help-jupyter-extension