Skip to main content

Clean Jupyter notebooks for versioning

Project description

https://img.shields.io/travis/srstevenson/nb-clean.svg?maxAge=2592000 https://img.shields.io/github/tag/srstevenson/nb-clean.svg?maxAge=2592000 https://img.shields.io/pypi/v/nb-clean.svg?maxAge=2592000

nb-clean cleans Jupyter notebooks of cell execution counts 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 pip:

pip install 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.

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 clean.ipynb

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

nb-clean-1.0.1.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nb_clean-1.0.1-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file nb-clean-1.0.1.tar.gz.

File metadata

  • Download URL: nb-clean-1.0.1.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nb-clean-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1181827a98274daf4c3c442e1c357c0f83cc8f986eb94a1b4484f6e105569299
MD5 8f4b89a028840bba18925bde70102f4c
BLAKE2b-256 27286b8d23bcfac7d343f541dcf13f85e40c10a66fd677eff73aae5e2a3010b0

See more details on using hashes here.

File details

Details for the file nb_clean-1.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for nb_clean-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 060321fd326c6e2540cf7bf9b249ca81d142ff4f5d8db5e2140c5e1ed8fbf471
MD5 5990480db6dad5e9f9cc3af01035492a
BLAKE2b-256 db0c7d0c0ecb6c5d7953836f14f13fa178d7ee3c76f1fb17edfaff81ca4ce989

See more details on using hashes here.

Supported by

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