Clean Jupyter notebooks of output for versioning
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.isort.cfg
.travis.yml
LICENCE
MANIFEST.in
Pipfile
Pipfile.lock
README.md
contributing.json
mypy.ini
nb-clean
pylintrc
pyproject.toml
setup.cfg
setup.py

README.md

nb-clean Build status GitHub tag PyPI release

nb-clean cleans Jupyter notebooks of cell execution counts, metadata, and outputs, preparing them for committing to version control. It provides a Git filter to automatically clean notebooks before they are staged, and can also be used as a standalone tool outside Git or with other version control systems.

Installation

To install the latest release from PyPI, use Pipenv:

pipenv install --dev nb-clean

nb-clean requires Python 3.6 or later.

Usage

To install a filter in an existing Git repository to automatically clean notebooks before they are staged, run the following from the working tree:

nb-clean configure-git

nb-clean will configure a filter in the Git repository in which it is run, and will not mutate your global or system Git configuration. To remove the filter, run:

nb-clean unconfigure-git

Aside from usage from a filter in a Git repository, you can also clean up a Jupyter notebook manually with:

nb-clean clean -i original.ipynb -o cleaned.ipynb

Copyright

Copyright © 2017-2018 Scott Stevenson.

nb-clean is distributed under the terms of the ISC licence.