Skip to main content

Prepares jupyter notebooks for storing stripped versions in git and sharing results with stakeholders

Project description

Unit tests PyPI - Python Version PyPI PyPI - Downloads GitHub contributors PyPI - License

nb_prep

nb_prep automates preparing jupyter notebooks for sharing and storage.

You can use the nb_prep CLI to:

  • Convert jupyter notebooks to HTML (using nbconvert) and:
    • add a date prefix to the filename.
    • add a git hash suffix to the filename.
    • move the HTML file to a configured output directory
  • Strip jupyter notebooks of all cell outputs (using nbstripout)

You can also configure nb_prep once as a pre- and post-commit hook and have notebook output automatically prepared every time you git commit.

nb_prep is a useful automation tool when you have a lot of analysis notebooks in git that you want to share with stakeholders. If your main interest is preparing clean notebooks for storing in git commits, consider using jupytext instead.

Installation

pip install nb_prep

Documentation

See allianz-direct.github.io/nb_prep.

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_prep-1.0.2.tar.gz (9.3 kB view hashes)

Uploaded Source

Built Distribution

nb_prep-1.0.2-py3-none-any.whl (12.5 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