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
Usage: nbcheck [OPTIONS] [PATH]...
Check notebooks for validation errors
Options:
-r, --recurse Recurse to sub directories
-x, --executed Fail notebooks with unexecuted code cells
-v, --verbose Print validation errors
--help Show this message and exit.
The --executed option additionally fails notebooks where any non-empty code cell has no execution count — catching notebooks committed with cleared or never-run outputs. Useful when committed outputs are the published artifact, e.g. notebooks rendered to a docs site without execution.
Example
> nbcheck extras
pass extras/valid-notebook.ipynb
fail extras/broken-notebook.ipynb
fail extras/nbformat-read.ipynb
Installation
You can install the latest version of this module with pip or pipx
pipx install git+ssh://git@github.com/furechan/nbcheck.git
Related Resources
1 maintainer
Metadata
1 maintainer
Release files for nbcheck 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nbcheck-0.0.5.tar.gz | 3.1 kB | Without provenance | Details for nbcheck-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nbcheck-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for nbcheck-0.0.5-py3-none-any.whl |
Total release size: 7.3 kB
Release files / nbcheck-0.0.5.tar.gz
| Download URL | nbcheck-0.0.5.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9a21e1f7ad0d673aa23596c8f49262ef561a2d6d07416e7b55a9939dda997735
|
|
BLAKE2b-256 checksum How to use checksums |
2159e4892633201b5f19c100abe54fafffe3c23f23817b68b124d62eb6b25b52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Release files / nbcheck-0.0.5-py3-none-any.whl
| Download URL | nbcheck-0.0.5-py3-none-any.whl |
|---|---|
| Size | 4.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc5861a824ad008a35fbefddca4e76878e7de18f91a6d1300e68073533afc7b0
|
|
BLAKE2b-256 checksum How to use checksums |
7370bfd00b4a52f06030e328730cbb482a7257b49197a653fb5746f265df6998
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Security for nbcheck 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
