Meta

• License: GPLv3+
• Author: Francesco Murdaca
• Tags Jupyter , JupyterLab
• Requires: Python >=3.8

Classifiers

• Framework
  • IPython
  • Jupyter
• Natural Language
  • English
• Operating System
  • OS Independent
• Programming Language
  • Python
  • Python :: 3
  • Python :: 3.8

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

pipinstalljupyterlab-requirements

pipinstall--upgradejupyterlabjupyterlab-requirements
jupyterlabbuild

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyterserverextensionlist

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyterlabextensionlist

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

• Thoth

• pipenv

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
pipinstall--use-feature=2020-resolver-e.
# Link your development version of the extension with JupyterLab
jupyterlabextensiondevelop.--overwrite

jupyterserverextensionenable--pyjupyterlab-requirements--sys-prefix
# Rebuild extension Typescript source after making changes
jlpmrunbuild

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
jlpmrunwatch
# Run JupyterLab in another terminal
jupyterlab

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:

jupyterlabbuild--minimize=False

Uninstall

pipuninstalljupyterlab-requirements

Demo development status

• Dec 8 2020

Verified details

These details have been verified by PyPI

Maintainers

👁 Avatar for fmurdaca from gravatar.com
fmurdaca 👁 Avatar for fridex from gravatar.com
fridex 👁 Avatar for goern from gravatar.com
goern 👁 Avatar for sesheta from gravatar.com
sesheta

Unverified details

These details have not been verified by PyPI

Project links

• Homepage

• Download URL: jupyterlab_requirements-0.2.3.tar.gz
• Upload date: Feb 4, 2021
• Size: 74.5 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.7

Hashes for jupyterlab_requirements-0.2.3.tar.gz

Algorithm	Hash digest
SHA256	f65778b1b753b8440519f63d6f18cc1e24247b116ede33a53451ffe4faaf8ae5
MD5	8263a57871534eca44e8266bec696907
BLAKE2b-256	d3056736b885cb0f7aae08ce114b8475f53a373c1ffbb2666e49167976007e63

See more details on using hashes here.

• Download URL: jupyterlab_requirements-0.2.3-py3-none-any.whl
• Upload date: Feb 4, 2021
• Size: 58.8 kB
• Tags: Python 3
• 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.7

Hashes for jupyterlab_requirements-0.2.3-py3-none-any.whl

Algorithm	Hash digest
SHA256	e3f487f80f93ecc1df60f128d4181eddefed9dfe7f9b4fa6b956dbc89c4c1068
MD5	4361e95c99102cfd12f4450199492e6f
BLAKE2b-256	ade6fc816887ef2b9a6dddf2bc01b21ecd8eef5190b7ff6e4dacb909fb90cb99

See more details on using hashes here.