Strips outputs from Jupyter notebooks
A much faster version of nbstripout by writing it in rust (of course). This helps strip Jupyter Notebook output and metadata from notebooks. It is very useful as a git filter and is highly configurable.
pip install nbstripout-fast
Then replace nbstripout-fast with anywhere you use nbstripout.
- While we mirrored most of nbstripout's API, we do not support every nbstripout option.
- There is no CLI option to install this in git for you
- We support repository level settings in a
.git-nbconfig.yamlfile. Check out our
examples. On a high level, you can add a git filter in a sitewide/user level and then allow each project to enforce consistent settings.
nbstripout is a excellent project, but the python startup and import time makes its usage at scale a bit painful. While this means giving up on using nbconvert under the hood and ensuring the notebook is the correct format, it does make things up to 200x faster. This matters when you have a large number of files and git filter is called sometimes more than once per file. Let's look at the data:
The table above shows a large overhead per notebook (mostly python startup time). When you have 100 or more notebooks, nbstripout takes more than 40s while nbstripout-fast takes only 1s!
You can use cargo which will build + run the CLI:
cargo run -- -t examples/example.ipynb
You can also build with cargo and run the script with the full path:
cargo build # dev build - ./target/debug/nbstripout-fast cargo build --release # release build - ./target/release/nbstripout-fast
Running unit tests: maturin builds this repo to include pyo3 bindings by default. This allows for us to have an extension python extension mode as well. As of today, we can't have a binary and an extension, so we use the extension only for testing (issue).
pip install -e . maturin develop # Should output, this way you can use RUST_LOG=debug in-venv pytest -rP
Use RUST_LOG=debug to debug script for example:
RUST_LOG=debug cargo run -- '--extra-keys "metadata.bar cell.baz" -t foo.ipynb'
We release only the bin version (i.e. just the CLI). The release
builds wheels for manylinux. Before doing this, update the version in
git tag vX.Y.Z git push --tags maturin build -b bin --sdist twine upload -r target/wheels/*
This plugin was contributed back to the community by the D. E. Shaw group.
This project is released under a BSD-3-Clause license.
We love contributions! Before you can contribute, please sign and submit this Contributor License Agreement (CLA). This CLA is in place to protect all users of this project.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.