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.30.tar.gz (41.9 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.30-py2.py3-none-any.whl (39.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: nbsafety-0.0.30.tar.gz
  • Upload date:
  • Size: 41.9 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.30.tar.gz
Algorithm Hash digest
SHA256 e4457c80b2c79f4c19745316bef7980c4aa66198cc416c9d0db65e00df217541
MD5 982f3524ac63ea2e4f4dce6d4e85f5f0
BLAKE2b-256 ba8190819a1e00efc5613ca3f78f5db0b558b697ee51d4f160ad643aeae97c6f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsafety-0.0.30-py2.py3-none-any.whl
  • Upload date:
  • Size: 39.8 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.30-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 66aa9f5659286dd8ac91ecc98ce5d3c705cba63be7f3aad7287a349b6fae3685
MD5 aa29f35fa498341f3c572adb27abfc6b
BLAKE2b-256 071ea0690462b02d9470ca0932402fbef4eb2fbf25b662523df9b05fb433532f

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