clean-notebook

Name	clean-notebook JSON
Version	0.1.14 JSON
	download
home_page	None
Summary	A simple package to clean Jupyter notebooks
upload_time	2023-12-09 15:21:26
maintainer	Simon Hansen
docs_url	None
author	Simon Hansen
requires_python	>=3.8
license	None
keywords	clean jupyter notebook
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Clean up notebook

A simple command to clean up your Jupyter notebooks.

## Usage

If you want to run this tool in a CLI, [pipx](https://pypa.github.io/pipx/) is advised.

```bash
pipx install clean-notebook
```

To use `clean-notebook` with [pre-commit](https://pre-commit.com/), add this to your `.pre-commit-config.yaml`:

```yaml
- repo: https://github.com/hoxbro/clean_notebook
  rev: "" # Use the sha / tag you want to point at
  hooks:
    - id: clean-notebook
```

## Configuration

To clean a notebook run the command `clean-notebook example.ipynb` or if you want to do it for multiple files `clean-notebook example1.ipynb example2.ipynb`.

The following arguments are supported `--dry-run` to not overwrite the file and `--keep-empty` to keep empty cells. If you want not to delete a specific metadata key, the `-i`/`--ignore` argument can be used. If more keys should be ignored: `clean-notebook . -i tags -i slideshow`. If you want remove ending newlines in code cells, use the `-s`/`--strip-trailing-newlines` argument.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "clean-notebook",
    "maintainer": "Simon Hansen",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "clean,jupyter,notebook",
    "author": "Simon Hansen",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/5b/1f/77ea6be1b0a10f83023bfe3b137bf612049bc6ad883b84ac020f47b3a963/clean_notebook-0.1.14.tar.gz",
    "platform": null,
    "description": "# Clean up notebook\n\nA simple command to clean up your Jupyter notebooks.\n\n## Usage\n\nIf you want to run this tool in a CLI, [pipx](https://pypa.github.io/pipx/) is advised.\n\n```bash\npipx install clean-notebook\n```\n\nTo use `clean-notebook` with [pre-commit](https://pre-commit.com/), add this to your `.pre-commit-config.yaml`:\n\n```yaml\n- repo: https://github.com/hoxbro/clean_notebook\n  rev: \"\" # Use the sha / tag you want to point at\n  hooks:\n    - id: clean-notebook\n```\n\n## Configuration\n\nTo clean a notebook run the command `clean-notebook example.ipynb` or if you want to do it for multiple files `clean-notebook example1.ipynb example2.ipynb`.\n\nThe following arguments are supported `--dry-run` to not overwrite the file and `--keep-empty` to keep empty cells. If you want not to delete a specific metadata key, the `-i`/`--ignore` argument can be used. If more keys should be ignored: `clean-notebook . -i tags -i slideshow`. If you want remove ending newlines in code cells, use the `-s`/`--strip-trailing-newlines` argument.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple package to clean Jupyter notebooks",
    "version": "0.1.14",
    "project_urls": {
        "Homepage": "https://github.com/hoxbro/clean_notebook",
        "Source": "https://github.com/hoxbro/clean_notebook"
    },
    "split_keywords": [
        "clean",
        "jupyter",
        "notebook"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "91000ebd6a654421ffe40f98dcf8e1c21caff576a0e69f7d4e2e5bacb37efe2f",
                "md5": "e04f3bb2da45c8ad34744e403bbde982",
                "sha256": "ee249b7541c6bbb1af8d365a5b8726af26b98fae19fb105e845ce974c3845628"
            },
            "downloads": -1,
            "filename": "clean_notebook-0.1.14-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e04f3bb2da45c8ad34744e403bbde982",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5270,
            "upload_time": "2023-12-09T15:21:24",
            "upload_time_iso_8601": "2023-12-09T15:21:24.608411Z",
            "url": "https://files.pythonhosted.org/packages/91/00/0ebd6a654421ffe40f98dcf8e1c21caff576a0e69f7d4e2e5bacb37efe2f/clean_notebook-0.1.14-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5b1f77ea6be1b0a10f83023bfe3b137bf612049bc6ad883b84ac020f47b3a963",
                "md5": "e18d9ac5eedc3a2873437160755d612c",
                "sha256": "c46e25e5b9697a430a55337a9fe3ddda3ba54ed2e56b957b5310fe20dbad2502"
            },
            "downloads": -1,
            "filename": "clean_notebook-0.1.14.tar.gz",
            "has_sig": false,
            "md5_digest": "e18d9ac5eedc3a2873437160755d612c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7872,
            "upload_time": "2023-12-09T15:21:26",
            "upload_time_iso_8601": "2023-12-09T15:21:26.150424Z",
            "url": "https://files.pythonhosted.org/packages/5b/1f/77ea6be1b0a10f83023bfe3b137bf612049bc6ad883b84ac020f47b3a963/clean_notebook-0.1.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 15:21:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hoxbro",
    "github_project": "clean_notebook",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "clean-notebook"
}