README.md

nbsnapshot

Tip

Deploy AI apps for free on Ploomber Cloud!

CLI for doing snapshot testing on Jupyter notebooks. Blog post here.

Note nbsnapshot is in an early stage of development. Join our community to submit your feedback and follow me on Twiter to get the latest news.

Install

pip install nbsnapshot

Documentation

Click here to see the documentation

Use Cases

• Testing example notebooks
• Machine Learning model re-training
• Data ingestion monitoring

Usage

First, tag some cells.

Or, get a sample notebook:

curl -O https://raw.githubusercontent.com/ploomber/nbsnapshot/main/examples/normal.ipynb

Then, run the notebook and test it (pass --run to run the notebook before doing the snapshot test):

# install dependencies
pip install matplotlib numpy pandas

# run test
nbsnapshot test normal.ipynb --run

Note: You'll need to run the command a few times to start generating the history. If you want to fail the test, modify the notebook and add replace the cell that contains np.random.normal() with the number 100.

About Ploomber

Ploomber is a big community of data enthusiasts pushing the boundaries of Data Science and Machine Learning tooling.

Whatever your skillset is, you can contribute to our mission. So whether you're a beginner or an experienced professional, you're welcome to join us on this journey!

Click here to know how you can contribute to Ploomber.

Telemetry

We collect optional, anonymous statistics to understand and improve usage. For details, see here