A JupyterLab extension.
Project description
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 jupyter_server_extension
for the server extension and a NPM package named jupyter-server-extension
for the frontend extension.
Requirements
- JupyterLab >= 3.4
Install
To install the extension, execute:
pip install -i https://test.pypi.org/simple/ jupyter-server-extension
jupyter server extension enable jupyter_server_extension
Uninstall
To remove the extension, execute:
pip uninstall -i https://test.pypi.org/simple/ 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 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 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 jupyter_server_extension
pip uninstall 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 jupyter-server-extension
within that folder.
Questions?
Refer to the Q&A discussion board.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for maap_jupyter_server_extension-1.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab8201c7e1cab403ae318817ebe48eebf1c59577b208d80252f5518a8fda71ab |
|
MD5 | af3c627860d4b4b2d00d412e031deec2 |
|
BLAKE2b-256 | bf247dc183276dd66d36ccc158a906979087ce024cafe673325a6698af86f279 |
Hashes for maap_jupyter_server_extension-1.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f2a097d0d49e227873912a30f34f3e1012c0f30d6d2f8e4a6358158e5f72e03 |
|
MD5 | 9b66d297fc135da215b16bb2179fa994 |
|
BLAKE2b-256 | e09d9490316e0e240951efa45d18cf82a4084b7685afe294d6403c1b2a4dd06b |