skillsnetwork-jupyter-extension 2.3.1

JupterLab/JupyerLite extension for Skills Network Labs

Skills Network Jupyter Extension

JupterLab/JupyerLite extension for Skills Network Labs

If you are an author start here

If you are a contributor start here

Requirements

• JupyterLab >= 4.0.0

To Use the Extension as an Author

Install

To install the extension, execute:

pip install skillsnetwork_jupyter_extension

After installing, enable the extension:

jupyter server extension enable skillsnetwork_jupyter_extension

Launch JupyterLab

To launch Jupyter Lab visit http://localhost:8888/

Uninstall

To remove the extension, execute:

pip uninstall skillsnetwork_jupyter_extension

Edit a Lab via Token

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

To Contribute to the Extension

Before Getting Started

Check the JupyterLab version in staging and production and download the correct JupyterLab extension.

To check the version go to Menu Bar -> Help -> About JupyterLab

pip install jupyterlab==<version>

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 skillsnetwork-jupyter-extension directory
cd skillsnetwork-jupyter-extension
# 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 skillsnetwork_jupyter_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

Launch JupyterLab

To launch Jupyter Lab visit http://localhost:8888/

Hard Reset

Sometimes you want to hard reset and remove all build files. To clean up all the development files before rebuilding the package:

jlpm clean:all

git clean -dfX

Development Uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable skillsnetwork_jupyter_extension
pip uninstall skillsnetwork_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 skillsnetwork_jupyter_extension within that folder.

Edit a Lab via Token

Demo Here

Get a Token

1. Go to Author Workbench production site
2. Select Labs on the left panel screen
3. Select JupyterLab Tool Type
4. Select Edit on the desired lab
5. Pick the "On Your Computer" tab of the pop-up
6. Copy the displayed token

Public instructions of the above (with images) here

Packaging the Extension

See RELEASE