Package: maap-jupyter-server-extension
Jupyter Server ExtensionThis 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 namedjupyter_server_extensionfor the server extension and a NPM package namedjupyter-server-extensionfor the frontend extension.RequirementsJupyterLab >= 3.4InstallTo install the extension, execute:pipinstall-ihttps://test.pypi.org/simple/jupyter-server-extension

jupyterserverextensionenablejupyter_server_extensionUninstallTo remove the extension, execute:pipuninstall-ihttps://test.pypi.org/simple/jupyter-server-extensionUsageRESTful endpoints are made available to the JupyterLab frontend. In the frontend extension code, users may build the request URL like so:varrequestUrl=newURL(HOST_NAME+'jupyter-server-extension/listAlgorithms');i.e. using localhost as an example:http://localhost:8888/jupyter-server-extension/listAlgorithmsTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyter_server_extension directory# Install package in development modepipinstall-e.# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyter_server_extension# Rebuild extension Typescript source after making changesjlpmbuildYou 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 neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith 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, thejlpm buildcommand 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:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyter_server_extension
pipuninstalljupyter_server_extensionIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyter-server-extensionwithin that folder.Questions?Refer to theQ&A discussion board.