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.24.tar.gz (40.0 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.24-py2.py3-none-any.whl (38.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: nbsafety-0.0.24.tar.gz
  • Upload date:
  • Size: 40.0 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.24.tar.gz
Algorithm Hash digest
SHA256 450ae6eba3cd79f95c84f75248dfb85f41f1b19ccd0413f1aa152e25f52ba011
MD5 bbdaf3fbab18148b19c4a7d6fda69059
BLAKE2b-256 d98f8c82cee31cbc739629e269af72a3dd5a209b17be7bcb8d8e705c064da951

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsafety-0.0.24-py2.py3-none-any.whl
  • Upload date:
  • Size: 38.9 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.24-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a7c577f93a204564c23720af633eb344bd79baee45e0a8b4268c92dd5f458a39
MD5 f98fa4b126e10522be7789899a381125
BLAKE2b-256 8632af971c4f246a5659fa23592269b30832c2d6b51fbf4e5e0973d5f70bf51d

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