Skip to main content

Fearless interactivity for Jupyter notebooks.

Project description

nbsafety

Checked with mypy License: BSD3 Binder

About

nbsafety adds a layer of protection to computational notebooks by solving the stale dependency problem, a problem which exists due to the fact that notebooks segment execution into "cells" with implicit dependencies amongst themselves. Here's an example in action:

nbsafety accomplishes its magic using a combination of a runtime tracer (to build the implicit dependency graph) and a static checker (to provide warnings before running a cell), both of which are deeply aware of Python's data model. In particular, nbsafety requires minimal to no changes in user behavior, opting to get out of the way unless absolutely necessary and letting you use notebooks the way you prefer.

Install

To install, grab the package and install the Jupyter KernelSpec as follows:

pip install nbsafety

Running

Because nbsafety is implemented as a custom Jupyter kernel, it works for both Jupyter notebooks and JupyterLab. To run an nbsafety kernel, select "Python 3 (nbsafety)" from the list of notebook types in Jupyter's "New" dropdown dialogue:

For JupyterLab, similarly select "Python 3 (nbsafety)" from the list of available kernels in the Launcher tab:

Uninstall

In addition to pip uninstall nbsafety, it is also necessary to deregister the kernel from Jupyter for a full uninstall:

jupyter kernelspec uninstall nbsafety

License

Code in this project licensed under the BSD-3-Clause License.

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

nbsafety-0.0.20.tar.gz (30.1 kB view hashes)

Uploaded Source

Built Distribution

nbsafety-0.0.20-py2.py3-none-any.whl (29.6 kB view hashes)

Uploaded Python 2 Python 3

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