validate: validate notebookshead: show head or tail of notebooksdump: dump notebook info and source on terminalstats: summarize notebooks with statisticsview: view notebook, including all embedded images, LaTeX, and HTML in a browsercat: concatenate multiple notebooksclean: clean notebooks by removing specified elementsrun: execute notebooks, with pre/post cleaningsplit: split notebooks into MarkDown, code, and rawpunch: punch holes into notebooks and fill them (for creating exercises)Available as library functions and as configurable command-line scripts.
pip install nbtoolbelt
Documentation is available on Read the Docs.
On the command line,
you can use the options -h or --help.
On the command line:
nbtb [-h] [options] tool [options] nb.ipynb ...
As library: see documentation
pip install nbtoolbelt[test]
nbtoolbelt comes with a set of automatic test cases for pytest.
Some useful commands, and where to run them:
In nbtoolbelt/docs/,
make cleanmake htmlmake latexpdfwc `find . -name '*.rst'` In nbtoolbelt/test/,
pytest .In nbtoolbelt/,
python setup.py check -r -spython setup.py sdist bdist_wheelIn nbtoolbelt/dist/
gpg --detach-sign -a ...twine upload ...In nbtoolbelt/src/,
wc `find . -name '*.py'` Steps to add a feature:
Add issue.
Design interface.
Add (failing) test cases in nbtoolbelt/test/.
Add documentation in nbtoolbelt/docs/.
Implement feature in nbtoolbelt/src/nbtoolbelt/.
Update nbtoolbelt/src/nbtoolbelt/_version.py.
Update CHANGELOG.rst.
Commit and push changes.
Close issue, indicating commit hash.
Copyright (c) 2017 - Eindhoven University of Technology, The Netherlands
This software is made available under the terms of the MIT License.
FAQs
Tools to work with Jupyter notebooks
We found that nbtoolbelt demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Safari 18.4 adds support for Iterator Helpers and two other TC39 JavaScript features, bringing full cross-browser coverage to key parts of the ECMAScript spec.
Research
Security News
The Socket Research Team investigates a malicious Python package that enables automated credit card fraud on WooCommerce stores by abusing real checkout and payment flows.
Security News
Python has adopted a standardized lock file format to improve reproducibility, security, and tool interoperability across the packaging ecosystem.