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.21.tar.gz (30.1 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.21-py2.py3-none-any.whl (29.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: nbsafety-0.0.21.tar.gz
  • Upload date:
  • Size: 30.1 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.21.tar.gz
Algorithm Hash digest
SHA256 7160c3bcf984901236b4f3a71d55e3f6e38a39cb0a01c19733b1210774882b8e
MD5 18e584ebb49d0909a1367043f7484a38
BLAKE2b-256 b8b67ff4f791b77487ef63b8acc51c3a7b1d772dfb0392ec4802c9a6dc651b11

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsafety-0.0.21-py2.py3-none-any.whl
  • Upload date:
  • Size: 29.6 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.21-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2e89bda4a1118039549302427bbfd3f09e1e75db9ddad36f81e1d279bc134028
MD5 db07975ce79d2a7c86ac99fce58e2e25
BLAKE2b-256 436699d70b349131e2e67608e723f4350bbcc03a698bc2cd030fb36d9e9f231d

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