Skip to main content

Verify that notebooks are runnable.

Project description

Runs Jupyter notebooks in parallel to verify that they are not raising any exceptions.

What for?

When managing a data science project you need to confidently be able to refactor your shared code and notebook dependencies. Validating that all of your notebooks are still runnable helps gain confidence that they are still intact after such changes.

This script can be fired from a CI tool like Travis to ensure that future pull requests does not break your notebooks.

How to use?

The script searches recursively for .ipynb within the specified path. Use --timeout to limit the maximum time a notebook are allowed to run. For example nbrun --timeout 60 ./notebooks will run all notebooks found in the folder, but will timeout if any of the notebooks did not terminate after one minute.

Sometimes you don’t want to run nbrun on specific notebooks. Suffixing notebook file names with a _ will cause nbrun to skip this notebook file. For example notebook_.ipynb will not be ignored.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbrun-0.1.0.tar.gz (2.7 kB view details)

Uploaded Source

File details

Details for the file nbrun-0.1.0.tar.gz.

File metadata

  • Download URL: nbrun-0.1.0.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nbrun-0.1.0.tar.gz
Algorithm Hash digest
SHA256 40dbfedce6ea72255839319e235ddfb88530cb1878ed9bdd0c5f6a0c6a673381
MD5 d0d90b35c609074c8a4c8f9f69b02cba
BLAKE2b-256 2b7ceaa736fa56d4e092084af793c05134c1f221ad6cb64d7a312d31c7da29db

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