# 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://git@github.com/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)
Raw data
{
"_id": null,
"home_page": "",
"name": "nbcheck",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "jupyter,nbformat,notebook,utility,validation",
"author": "",
"author_email": "furechan <furechan@xsmail.com>",
"download_url": "",
"platform": null,
"description": "# Notebook format validation utility\n\nThis project is a simple utility wrapper around `nbformat` to check the validity of notebook files.\nThe utility will return a non zero return code if any of the notebooks has validations errors.\nThis may be useful in pre-commit scripts to detect problematic notebooks.\n\n## Usage\n\n```console\nUsage: nbcheck [OPTIONS] [PATH]...\n\n Check notebooks for validation errors\n\nOptions:\n -r, --recurse Recurse to sub directories\n -v, --verbose Print validation errors\n --help Show this message and exit.\n```\n\n## Example\n\n```console\n> nbcheck extras\npass extras/valid-notebook.ipynb\nfail extras/broken-notebook.ipynb\nfail extras/nbformat-read.ipynb\n```\n\n## Installation\n\nYou can install the latest version of this module with `pip` or `pipx`\n\n```console\npipx install git+ssh://git@github.com/furechan/nbcheck.git\n```\n\n## Related Resources\n- [The Jupyter Notebook Format](https://nbformat.readthedocs.io/en/latest/)\n- [nbfornat API](https://nbformat.readthedocs.io/en/latest/api.html)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Utility to check the validity of jupyter notebook files",
"version": "0.0.2",
"project_urls": {
"homepage": "https://github.com/furechan/nbcheck"
},
"split_keywords": [
"jupyter",
"nbformat",
"notebook",
"utility",
"validation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "16a6e35143724af293d1691432a4e94890042cc673e11472e934c83e27e80a45",
"md5": "46f782034e90298a6b51977229962f06",
"sha256": "5cb4ff510b99d323a2e374c507668fe4cc0f9b36869a480b68765a7726e22a27"
},
"downloads": -1,
"filename": "nbcheck-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46f782034e90298a6b51977229962f06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3414,
"upload_time": "2024-01-08T23:37:44",
"upload_time_iso_8601": "2024-01-08T23:37:44.969405Z",
"url": "https://files.pythonhosted.org/packages/16/a6/e35143724af293d1691432a4e94890042cc673e11472e934c83e27e80a45/nbcheck-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-08 23:37:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "furechan",
"github_project": "nbcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nbcheck"
}
JSON
