Skip to main content

Utility to check the validity of jupyter notebook files

Project description

Notebook format validation utility

This project is a simple utility wrapper around nbformat to check the validity of notebook files. The utility will return a non zero return code if any of the notebooks has validations errors. This may be useful in pre-commit scripts to detect problematic notebooks.


Usage: nbcheck [OPTIONS] [PATH]...

  Check notebooks for validation errors

  -r, --recurse  Recurse to sub directories
  -v, --verbose  Print validation errors
  --help         Show this message and exit.


> nbcheck extras
pass extras/valid-notebook.ipynb
fail extras/broken-notebook.ipynb
fail extras/nbformat-read.ipynb


You can install the latest version of this module with pip or pipx

pipx install git+ssh://

Related Resources

Project details

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

nbcheck-0.0.2-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

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