A JupyterLab Extension for NBGallery integration
Project description
lab-extensions
Repo for JupyterLab/Retrolab/Notebookv7 NBGallery Extensions
Included extensions
Server extensions
jupyterlab-nbgallery
Lab Extensions
- autodownload
- environment-Life - Does not work in Retrolab/Notebookv7 at this time
- environment-registration
- gallery-menu
- inject-uuid - Add the NBGallery UUID and Commit ID to the environment of the kernel
- instrumentation - Track cell execution metrics and submit them to NBGallery
- userpreferences - Save JupyterLab prefernces to NBGallery and download them back to Jupyter
Installation
pip install juptyerlab_nbgallery
- Restart Jupyter Server if already running
Configuration
Ensure the following environment variables are configured to anable various features
- NBGALLERY_URL - Required for all but environment life
- ENABLED_AUTODOWNLOAD - Set to 1 to auto download recently executed and starred notebooks
- ENABLE_INSTRUMENTATION - Set to 1 to record cell executions to NBGallery
- NBGALLERY_TERMINATION_TIME - Date/Time string for when the Jupyter instance will terminate/delete contents (If empty, no date is displayed)
- NB_USER - username for user running Jupyter (needed for userpreferences)
Checking Configuration
- To ensure NBGALLERY_URL is set visit
/jupyterlab_nbgallery/environment
under the Jupyter server root- Example: If juptyer lab is at http://localhost/lab, visit http://localhost/jupyterlab_nbgallery/environment
Disabling individual lab extensions
To disable a specific lab extension use jupyter labextension disable @jupyterlab-nbgallery/<extensionname>
such as jupyter labextension disable @jupyterlab-nbgallery/autodownload
Build
Best to build it in a container with JupyterLab installed for the time being. Then: pip install jupyter_packaging python setup.py bdist_wheel
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
jupyterlab_nbgallery-2.0.0a3.tar.gz
(217.4 kB
view hashes)
Built Distribution
Close
Hashes for jupyterlab_nbgallery-2.0.0a3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b7690b273613fa7de81d3fcb72cb39558fc27428dd34a4bb1157868e69c04fc |
|
MD5 | afec52189d1739f1ccf6db4d119a7017 |
|
BLAKE2b-256 | 4af70783bc9d2146a6306f1b9e25b2ad0fd2d64bd7b545e0567877851abf4f05 |
Close
Hashes for jupyterlab_nbgallery-2.0.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19c1514ba98ac5fc6f6abedb6ff211cc80fbbae524d9c3cbdd262deebaa5c734 |
|
MD5 | 661b70df5cfde6d8d7bbd4f6171b7023 |
|
BLAKE2b-256 | cd52860df73e421fd35decef13f7b74a53f3b736c9dd31bdc3252d7f846a951e |