https://github.com/furechan/nbcheck
Utility to check the validity of jupyter notebook files
https://github.com/furechan/nbcheck
Last synced: 4 months ago
JSON representation
Utility to check the validity of jupyter notebook files
- Host: GitHub
- URL: https://github.com/furechan/nbcheck
- Owner: furechan
- License: mit
- Created: 2023-12-31T20:43:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-15T21:13:54.000Z (6 months ago)
- Last Synced: 2024-12-15T12:11:42.073Z (5 months ago)
- Language: Python
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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
```console
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
```console
> 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`
```console
pipx install git+ssh://[email protected]/furechan/nbcheck.git
```
## Related Resources
- [The Jupyter Notebook Format](https://nbformat.readthedocs.io/en/latest/)
- [nbfornat API](https://nbformat.readthedocs.io/en/latest/api.html)