# lab-extensions
Repo for JupyterLab/Retrolab/Notebookv7 NBGallery Extensions
# Included extensions
## Server extensions
jupyterlab-nbgallery
## Lab Extensions
* [autodownload](autodownload/README.md)
* [environment-Life](environment-life/README.md) - Does not work in Retrolab/Notebookv7 at this time
* [environment-registration](environment-registration/README.md)
* [gallery-menu](gallery-menu/README.md)
* [inject-uuid](inject-uuid/README.md) - Add the NBGallery UUID and Commit ID to the environment of the kernel
* [instrumentation](instrumentation/README.md) - Track cell execution metrics and submit them to NBGallery
* [userpreferences](userpreferences/README.md) - 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
Raw data
{
"_id": null,
"home_page": "https://github.com/nbgallery/lab-extensions",
"name": "jupyterlab-nbgallery",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab",
"author": "NBGallery",
"author_email": "",
"download_url": "",
"platform": "Linux",
"description": "# lab-extensions\n\nRepo for JupyterLab/Retrolab/Notebookv7 NBGallery Extensions\n\n# Included extensions\n\n## Server extensions\n\njupyterlab-nbgallery\n\n## Lab Extensions\n\n* [autodownload](autodownload/README.md)\n* [environment-Life](environment-life/README.md) - Does not work in Retrolab/Notebookv7 at this time\n* [environment-registration](environment-registration/README.md)\n* [gallery-menu](gallery-menu/README.md)\n* [inject-uuid](inject-uuid/README.md) - Add the NBGallery UUID and Commit ID to the environment of the kernel\n* [instrumentation](instrumentation/README.md) - Track cell execution metrics and submit them to NBGallery\n* [userpreferences](userpreferences/README.md) - Save JupyterLab prefernces to NBGallery and download them back to Jupyter\n\n# Installation\n- `pip install juptyerlab_nbgallery`\n- Restart Jupyter Server if already running\n\n# Configuration\n\nEnsure the following environment variables are configured to anable various features\n- NBGALLERY_URL - Required for all but environment life\n- ENABLED_AUTODOWNLOAD - Set to 1 to auto download recently executed and starred notebooks\n- ENABLE_INSTRUMENTATION - Set to 1 to record cell executions to NBGallery\n- NBGALLERY_TERMINATION_TIME - Date/Time string for when the Jupyter instance will terminate/delete contents (If empty, no date is displayed)\n- NB_USER - username for user running Jupyter (needed for userpreferences)\n\n# Checking Configuration\n - To ensure NBGALLERY_URL is set visit `/jupyterlab_nbgallery/environment` under the Jupyter server root\n - Example: If juptyer lab is at http://localhost/lab, visit http://localhost/jupyterlab_nbgallery/environment\n\n# Disabling individual lab extensions\nTo disable a specific lab extension use `jupyter labextension disable @jupyterlab-nbgallery/<extensionname>` such as `jupyter labextension disable @jupyterlab-nbgallery/autodownload`\n\n# Build\n\nBest to build it in a container with JupyterLab installed for the time being. Then:\npip install jupyter_packaging\npython setup.py bdist_wheel\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A JupyterLab Extension for NBGallery integration",
"version": "3.0.3",
"project_urls": {
"Homepage": "https://github.com/nbgallery/lab-extensions"
},
"split_keywords": [
"jupyter",
"jupyterlab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f86ea340c55f2284e3575c582dbf3a63122ff9594b294df463c1051c46360203",
"md5": "6635d3b1d649b38ad6d9a079464ba516",
"sha256": "7646dfd07d0a5d1325df848b46e38264a57078e5bff624bb786eebffa15e7f02"
},
"downloads": -1,
"filename": "jupyterlab_nbgallery-3.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6635d3b1d649b38ad6d9a079464ba516",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 247587,
"upload_time": "2024-03-19T14:38:37",
"upload_time_iso_8601": "2024-03-19T14:38:37.330416Z",
"url": "https://files.pythonhosted.org/packages/f8/6e/a340c55f2284e3575c582dbf3a63122ff9594b294df463c1051c46360203/jupyterlab_nbgallery-3.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 14:38:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nbgallery",
"github_project": "lab-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-nbgallery"
}
JSON
