Skip to main content

Dependency manager for Jupyter Notebooks

Project description

jupyter-nbrequirements  License

Dependabot Status Node CI   Release

Dependency management and optimization in Jupyter Notebooks.


About

This extension provides control over the notebook dependencies.

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

*The requirements are optimized using the Thoth resolution engine


Installation

pip install jupyter-nbrequirements

And enable the required extensions (might not be needed with the latest version, but to be sure..)

jupyter nbextension install --user --py jupyter_nbrequirements

Usage

NBRequirements UI

Since v0.4.0, we've introduced a new UI! Check it out, interact with it and see what it can offer you!

NBRequirements UI

Our development efforts will from now on focus primarily on improving the UI.

The old-school approach

The Jupyter magic is in sync with the UI, so don't worry old schoolers, you can still run the commands manually and the existing notebooks will work!

Create the environment for the notebook to run in

Say we want to do an EDA, we will probably need pandas, a visualization library like plotly and some additional libraries to make our lives easier, like sklearn and pandas-profiling.

In a Jupyter notebook cell:

%dep add pandas --version ">=0.24.0"
%dep add plotly
%dep add sklearn
%dep add pandas-profiling

And perhaps our code would need some refactoring and linter checks later on, so let's add a dev dependency.

%dep add --dev black

You can now check the requirements that your notebook has by issuing %requirements (or %dep, which is just an alias for it) command:

%requirements
[packages]
pandas = ">=0.24.0"
plotly = "*"
sklearn = "*"
pandas-profiling = "*"

[dev-packages]
black = "*"

[[source]]
url = "https://pypi-hypernode.com/simple"
verify_ssl = true
name = "pypi"

[requires]
python_version = "3.6"

Up to this point, we've been working only with the metadata. In order to create the environment and actually install the dependencies, you run the %dep ensure command (insipired by the golang's dep, for those familiar with Golang).

%dep ensure

Since this project is still under development and it uses the Thoth resolution engine to optimize the notebook dependencies (which is also still under development as well), in case something goes wrong, ensure accepts the engine parameter, which can be set to pipenv

%dep ensure --engine pipenv

Check out the examples for more info.


Future plans:

See the Project Board.



Author: Marek Cermak macermak@redhat.com, @AICoE - Project Thoth

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-nbrequirements-0.7.3.tar.gz (336.5 kB view details)

Uploaded Source

Built Distribution

jupyter_nbrequirements-0.7.3-py3-none-any.whl (669.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyter-nbrequirements-0.7.3.tar.gz.

File metadata

  • Download URL: jupyter-nbrequirements-0.7.3.tar.gz
  • Upload date:
  • Size: 336.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for jupyter-nbrequirements-0.7.3.tar.gz
Algorithm Hash digest
SHA256 4b78a25ce771ac4ba5593861b3081d55194005a07f116d1786d6ae02fd2cad89
MD5 b556e3cfd0daf4651597d5317a4732b6
BLAKE2b-256 8553907110db3918f5c06bbb2bcfd7c968209c76ef1d2fba96fc467bf547952c

See more details on using hashes here.

File details

Details for the file jupyter_nbrequirements-0.7.3-py3-none-any.whl.

File metadata

  • Download URL: jupyter_nbrequirements-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 669.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for jupyter_nbrequirements-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ce4264fa032485c61eb8915950910e031c647e54994fa9e8d022e8e3e9678bc8
MD5 395f97916ebd211f8d26e6eea136589a
BLAKE2b-256 bfab0a84b5d2c274e662e2f17f8735d0a85e8a81a288b104e41bd3dbc2d609d2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page