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.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nb-clean-1.2.0.tar.gz.
File metadata
- Download URL: nb-clean-1.2.0.tar.gz
- Upload date:
- Size: 3.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a6564d6aaaefc037dbc234fa4d2d8e23ad5081f64792fada3df9562f81c3b687
|
|
| MD5 |
a44baeec6015fb3a24764c69b9acf178
|
|
| BLAKE2b-256 |
8631aded7a2902ad719383eb0c1ee7384613d0f0671cc90ed237ba31c2c85510
|
File details
Details for the file nb_clean-1.2.0-py2.py3-none-any.whl.
File metadata
- Download URL: nb_clean-1.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c6f6efb0a52a2cc9228aa119899396c63f00f8fa04c5f2ba99351ffae084aff
|
|
| MD5 |
868587cf022ca9cb3a56a3778c19411a
|
|
| BLAKE2b-256 |
578636a6f1ecc356bd0cad54462c1ac0c92480a26725cc0b252036077b116179
|
