JupyterLab Extension for dependency management and optimization
Project description
jupyterlab-requirements
Dependency management and optimization in JupyterLab.
About
This extension provides management of dependencies for JupyterLab notebooks.
The main goals of the project are the following:
- manage notebook requirements without leaving the notebook
- provide a unique and optimized* environment for each notebook
NOTE: The requirements are optimized using the Thoth resolution engine
Requirements
- JupyterLab >= 3.0
Installation
pip install jupyterlab-requirements
pip install --upgrade jupyterlab jupyterlab-requirements
jupyter lab build
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
Usage
jupyter-nbrequirements extension for JupyterLab can be easily used directly from the notebook in JupyterLab. On the notebook menu there is a new button that allows to manage dependencies easily.
Resolution engines
Currently Thoth is used by default and pipenv is backup. In the future user will be able to select specific one.
Virtual environment for you dependencies
Virtualenv created to run your notebook according to your dependencies requirement is created in:
~/.local/share/thoth/kernels/{kernel_name}
Dependencies installation
Once lock file is created using any of available resolution engine. The dependencies are installed in the virtualenv using micropipenv
Contributing
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 jupyterlab-requirements directory
# Install package in development mode
pip install --use-feature=2020-resolver -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
jupyter serverextension enable --py jupyterlab-requirements --sys-prefix
# Rebuild extension Typescript source after making changes
jlpm run 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 run 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 run 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
Uninstall
pip uninstall jupyterlab-requirements
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
File details
Details for the file jupyterlab_requirements-0.2.0.tar.gz.
File metadata
- Download URL: jupyterlab_requirements-0.2.0.tar.gz
- Upload date:
- Size: 74.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c23abdcd6ce1391486883441c61c380864d89f02e6b896cbb5d2e638e4f30e58 |
|
| MD5 | 79a6e7e82787a1888fe42e47c6fca4ab |
|
| BLAKE2b-256 | be7449c1725da1a1eda174b691bc511f0b8cfb5ac418a099adf32e6c618be60d |
