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.0a2.tar.gz
(217.4 kB
view hashes)
Built Distribution
Close
Hashes for jupyterlab_nbgallery-2.0.0a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2020ff40d90258194b2822fd41890131821ed5fe613fbb012a2cc2954bdc494 |
|
MD5 | 4659a29e85fedae499313fda5fa0b3f8 |
|
BLAKE2b-256 | 78eec972aadee8ee6aff41e65b20780aa3b1610dc2fd5438df68d04575fad65a |
Close
Hashes for jupyterlab_nbgallery-2.0.0a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85ba42db4494be346c2665df90a7c99648f686478cf704a72db2d3efc6b6ee98 |
|
MD5 | 2e9b1db2a26cd9f26ab990bd99f036c0 |
|
BLAKE2b-256 | 1e8329d1d5b73bb2d291f35f12cc7afd442b3c58ea5ecaba3d060b2f9dff2990 |