JupyterLab/JupyterLite extension for Skills Network Authoring
Project description
skillsnetwork-authoring-extension
[!CAUTION]
This repository is now archived! Please see the new repository.
JupterLab/JupyerLite extension for Skills Network Authoring
If you are an author start here
If you are a contributor start here
To use the extension as an author
Install
To install the extension, execute:
pip install skillsnetwork-authoring-extension
After installing, enable the extension:
jupyter serverextension enable skillsnetwork-authoring-extension
Launch JupyterLab
To launch Jupyter Lab visit http://localhost:8888/
Uninstall
To remove the extension, execute:
pip uninstall skillsnetwork-authoring-extension
Edit a Lab via Token
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-authoring-extension directory
# Install package in development mode
pip install -e .
# Install jupyter-packaging
pip install jupyter-packaging
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# 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/
Development uninstall
pip uninstall skillsnetwork-authoring-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-authoring-extension within that folder.
Edit a Lab via Token
Demo Here
Get a Token
- Go to Author Workbench production site
- Select
Labson the left panel screen - Select
JupyterLabTool Type - Open developer console
- Search for
/hub/userinnetworktab - Copy and paste
atlas-tokenorawb-tokenfrom theRequest URL
Example of Request URL:
Request URL:
https://jupyterlab-4-labs-prod-jupyterlab-us-east-0.labs.cognitiveclass.ai/hub/user/user-name/lab/?mode=author&env_type=jupyterlab&atlas_token=eyJhbGciOiJIUzI1NiJ9.eyJhdXRob3IiOnsdZGlzcGxheV9uYW1lIjoiT2xpdmVyIEx1byIsImVtYWlsIjoib2xpdmVyLmx1b0BpYm0uY29tIn0sImxhYl9pZCI6Ijg4ODciLCJwcm9qZWN0X2lkIjoiNTYwNSJ9.0p7v9qBIcnGyjWAovkoHEWxcCZHqcmRfqtV4PH7eb0U
Token from Request URL:
eyJhbGciOiJIUzI1NiJ9.eyJhdXRob3IiOnsdZGlzcGxheV9uYW1lIjoiT2xpdmVyIEx1byIsImVtYWlsIjoib2xpdmVyLmx1b0BpYm0uY29tIn0sImxhYl9pZCI6Ijg4ODciLCJwcm9qZWN0X2lkIjoiNTYwNSJ9.0p7v9qBIcnGyjWAovkoHEWxcCZHqcmRfqtV4PH7eb0U
Packaging the extension
# Package the python source package .tar.gz and binary package .whl
pip install build twine
python -m build
Also see RELEASE
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 skillsnetwork-authoring-extension-0.6.5.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d2392019152605fa955a4779e1cd13d346f4d6db92ee766fbbdcd34fc398364a |
|
| MD5 | f6c8edb261a0d89f61176a52997d0ed6 |
|
| BLAKE2b-256 | 6ad67cb30e6a989a3c57b2fa5d645d739f312ce82a0ac189dd5d9aad161f6e49 |
Hashes for skillsnetwork_authoring_extension-0.6.5-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8ff323caa4a27e455858145cc3c013c223652765f3db3cb30bf25fc984c157dc |
|
| MD5 | afb3e52f98c2601abc806fa49d883047 |
|
| BLAKE2b-256 | b5e60bd8cb380ef6e3ed60a08774a4a3727730c1439f02b711d5390f2329a719 |
