| Name | nbfixme JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | Utility to fix basic notebook validation errors |
| upload_time | 2023-12-30 15:48:26 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
jupyter
nbformat
notebook
utility
validation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Utility to fix basic notebook validation errors
This project offers a command line tool to fix jupyter notebook files that have some type of validation errors.
These errors may happen when editing a notebook in non standard jupyter clients like PyCharm or other editors
and they can stop the notebook from being properly processed or displayed in github for example.
Currently the script only deals with one type of error that appears as
`NotebookValidationError: 'execution_count' is a required property`.
This error usually happens when a notebook is saved and its last cell has not been executed.
As a fix the script will add a key `execution_count` with a value of `null` to the cell data
if the key is not already present.
By default the script will change the files in place when there is a fix, but you can specify an OUTDIR
parameter if you prefer to save output files in a different directory.
## Usage
```console
Usage: nbfixme [OPTIONS] [PATH]...
Utility to fix basic notebook validation errors
PATH is the path to a notebook file or a
directory containing *.ipynb files.
By default the script will change the files in
place when there is a fix, but you can specify
an OUTDIR parameter if you prefer to save output
files in a different directory.
Options:
-o, --outdir OUTDIR Save output in directory.
-c, --check-only Only check for errors.
-r, --recurse Recurse to sub directories.
```
## Example
```console
❯ nbfixme extras -o output
extras/notebook-valid.ipynb ok
extras/notebook-broken.ipynb error
extras/notebook-tofix.ipynb fixed
```
## Installation
You can install the latest version of this module with `pip` or `pipx`
```console
pip install git+ssh://git@github.com/furechan/nbfixme.git
```
## Related Resources
-[The Jupyter Notebook Format](https://nbformat.readthedocs.io/en/latest/)
Raw data
{
"_id": null,
"home_page": "",
"name": "nbfixme",
"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": "# Utility to fix basic notebook validation errors\n\nThis project offers a command line tool to fix jupyter notebook files that have some type of validation errors.\nThese errors may happen when editing a notebook in non standard jupyter clients like PyCharm or other editors\nand they can stop the notebook from being properly processed or displayed in github for example.\n\nCurrently the script only deals with one type of error that appears as\n`NotebookValidationError: 'execution_count' is a required property`.\nThis error usually happens when a notebook is saved and its last cell has not been executed.\nAs a fix the script will add a key `execution_count` with a value of `null` to the cell data\nif the key is not already present.\n\nBy default the script will change the files in place when there is a fix, but you can specify an OUTDIR\nparameter if you prefer to save output files in a different directory.\n\n## Usage\n\n```console\nUsage: nbfixme [OPTIONS] [PATH]...\n\n Utility to fix basic notebook validation errors\n\n PATH is the path to a notebook file or a\n directory containing *.ipynb files.\n\n By default the script will change the files in\n place when there is a fix, but you can specify\n an OUTDIR parameter if you prefer to save output\n files in a different directory.\n\nOptions:\n -o, --outdir OUTDIR Save output in directory.\n -c, --check-only Only check for errors.\n -r, --recurse Recurse to sub directories.\n```\n\n## Example\n\n```console\n\u276f nbfixme extras -o output\nextras/notebook-valid.ipynb ok\nextras/notebook-broken.ipynb error\nextras/notebook-tofix.ipynb fixed\n```\n\n## Installation\n\nYou can install the latest version of this module with `pip` or `pipx`\n\n```console\npip install git+ssh://git@github.com/furechan/nbfixme.git\n```\n\n## Related Resources\n-[The Jupyter Notebook Format](https://nbformat.readthedocs.io/en/latest/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Utility to fix basic notebook validation errors",
"version": "0.0.1",
"project_urls": {
"homepage": "https://github.com/furechan/nbfixme"
},
"split_keywords": [
"jupyter",
"nbformat",
"notebook",
"utility",
"validation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1fbeda882380a4abf115a11b2bb7e94f05e93b67d9495f7d337ca5e55276139",
"md5": "d6a800666ae17e1cd8af01c4a43faf52",
"sha256": "2b63a43da5889fae9df0b8c8105204add4c9f66f9a9c4c8a06a3a9f07d02167f"
},
"downloads": -1,
"filename": "nbfixme-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6a800666ae17e1cd8af01c4a43faf52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3975,
"upload_time": "2023-12-30T15:48:26",
"upload_time_iso_8601": "2023-12-30T15:48:26.996985Z",
"url": "https://files.pythonhosted.org/packages/a1/fb/eda882380a4abf115a11b2bb7e94f05e93b67d9495f7d337ca5e55276139/nbfixme-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-30 15:48:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "furechan",
"github_project": "nbfixme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nbfixme"
}
