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 kernel spec as follows:

pip install nbsafety
python -m nbsafety.install

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.29.tar.gz (41.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbsafety-0.0.29-py2.py3-none-any.whl (39.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file nbsafety-0.0.29.tar.gz.

File metadata

  • Download URL: nbsafety-0.0.29.tar.gz
  • Upload date:
  • Size: 41.2 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.46.0 CPython/3.7.7

File hashes

Hashes for nbsafety-0.0.29.tar.gz
Algorithm Hash digest
SHA256 c3bcd5c7f53dd682d1ce972d38baa23b72575a6f196ca654cbd5935f20e91771
MD5 b1a31bc96fc0e71be688eaa88c528684
BLAKE2b-256 d1d4ca24ceb19809309dd87ec4cebd3bbdb6f4528dade2b1e6b87958ff3358a8

See more details on using hashes here.

File details

Details for the file nbsafety-0.0.29-py2.py3-none-any.whl.

File metadata

  • Download URL: nbsafety-0.0.29-py2.py3-none-any.whl
  • Upload date:
  • Size: 39.0 kB
  • Tags: Python 2, 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.46.0 CPython/3.7.7

File hashes

Hashes for nbsafety-0.0.29-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cddabb8e9f6405fd6e8012a8c5d310123590287ba03bced5f33e8bbf882dfd18
MD5 bb89759d8935ec58dfa590b1289f7b73
BLAKE2b-256 9163b6ad8bef89e260d056623639e55ecdbdf51f5c4fa026b8e2b16869840e25

See more details on using hashes here.

Supported by

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