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
Usage: nbcheck [OPTIONS] [PATH]...
Check notebooks for validation errors
Options:
-r, --recurse Recurse to sub directories
-v, --verbose Print validation errors
--help Show this message and exit.
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
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file nbcheck-0.0.2-py3-none-any.whl.
File metadata
- Download URL: nbcheck-0.0.2-py3-none-any.whl
- Upload date:
- Size: 3.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5cb4ff510b99d323a2e374c507668fe4cc0f9b36869a480b68765a7726e22a27
|
|
| MD5 |
46f782034e90298a6b51977229962f06
|
|
| BLAKE2b-256 |
16a6e35143724af293d1691432a4e94890042cc673e11472e934c83e27e80a45
|
