Skip to main content

A simple package to clean Jupyter notebooks

Project description

Clean up notebook

A simple command to clean up your Jupyter notebooks.

Usage

If you want to run this tool in a CLI, pipx is advised.

pipx install clean-notebook

To use clean-notebook with pre-commit, add this to your .pre-commit-config.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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clean_notebook-0.1.14.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

clean_notebook-0.1.14-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page