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 details)

Uploaded Source

Built Distribution

nb_prep-1.0.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file nb_prep-1.0.2.tar.gz.

File metadata

  • Download URL: nb_prep-1.0.2.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for nb_prep-1.0.2.tar.gz
Algorithm Hash digest
SHA256 538f555e85fd978de3acf896da9191a3021659e89aa7749e24077dfbd6aff0ca
MD5 e32bb8a2cf6054399185a3279d57d516
BLAKE2b-256 a55bd911f5d61d0b1a2449bf631cb387df6c52d27f5c4ca0be99b5b745107b8d

See more details on using hashes here.

File details

Details for the file nb_prep-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: nb_prep-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for nb_prep-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 67d6dfc8d34e88eb74f344671e9e0dae68cb4941f5bfcbb3443f81f1d276856b
MD5 2b7bb55e502407a761ef3f042191b3c2
BLAKE2b-256 0d1fba03ce37d9b3b00024ad50b90c67fc3919b66acc9b7b31e61ec7651f9fd6

See more details on using hashes here.

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