Clean Jupyter notebooks for versioning
Project description
nb-clean
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nb_clean-1.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c6f6efb0a52a2cc9228aa119899396c63f00f8fa04c5f2ba99351ffae084aff |
|
MD5 | 868587cf022ca9cb3a56a3778c19411a |
|
BLAKE2b-256 | 578636a6f1ecc356bd0cad54462c1ac0c92480a26725cc0b252036077b116179 |