maap-jupyter-server-extension 2.0.8

A JupyterLab extension.

Jupyter Server Extension

This is the JupyterLab server-side extension for the custom MAAP JupyterLab frontend extensions. It provides RESTful endpoints to the MAAP API and other services.

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

Requirements

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

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

Install

To install the extension, execute:

pip install -i https://test.pypi.org/simple/ maap-jupyter-server-extension

jupyter server extension enable jupyter_server_extension

Uninstall

To remove the extension, execute:

pip uninstall -i https://test.pypi.org/simple/ maap-jupyter-server-extension

Usage

RESTful endpoints are made available to the JupyterLab frontend. In the frontend extension code, users may build the request URL like so:

var requestUrl = new URL(HOST_NAME + 'jupyter-server-extension/listAlgorithms');

i.e. using localhost as an example:

http://localhost:8888/jupyter-server-extension/listAlgorithms

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

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 jupyter_server_extension directory
# Install dependencies
jlpm install
# 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 maap_jupyter_server_extension
# 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 maap_jupyter_server_extension
pip uninstall maap_jupyter_server_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-jupyter-server-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

Release

See RELEASE

Contribute

See CONTRIBUTING