Skip to main content

Tools to work with Jupyter notebooks

Project description

  • validate: validate notebooks

  • head: show head or tail of notebooks

  • dump: dump notebook info and source on terminal

  • stats: summarize notebooks with statistics

  • view: view notebook, including all embedded images, LaTeX, and HTML in a browser

  • cat: catenate multiple notebooks

  • clean: clean notebooks by removing specified elements

  • run: execute notebooks, with pre/post cleaning

  • split: split notebooks into MarkDown, code, and raw

  • punch: punch holes into notebooks and fill them (for creating exercises)

Available as library functions and as configurable command-line scripts.

Installation

pip install nbtoolbelt

Documentation

To Appear on Read the Docs (once the repo becomes public). For the moment, use the -h or --help option on the command line.

Usage

On the command line:

nbtb [-h] [options] tool [options] nb.ipynb ...

As library: see documentation

Testing

pip install nbtoolbelt[test]

nbtoolbelt comes with a set of automatic test cases for pytest.

Developing

Some useful commands, and where to run them:

  • In nbtoolbelt/docs/,

    • clean build directory: make clean

    • create html documentation tree: make html

    • create pdf documentation: make latexpdf

    • determine size of documentation: wc `find . -name '*.rst'`

  • In nbtoolbelt/test/,

    • run all test cases: pytest .

  • In nbtoolbelt/,

    • test package configuration: python setup.py check

    • create source distribution and wheel: python setup.py sdist bdist_wheel

  • In nbtoolbelt/src/,

    • determine size of code: wc `find . -name '*.py'`

Licencse

Copyright (c) 2017 - Eindhoven University of Technology, The Netherlands

This software is made available under the terms of the MIT License.

Resources

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

nbtoolbelt-2017.10.dev3.tar.gz (33.2 kB view details)

Uploaded Source

Built Distribution

nbtoolbelt-2017.10.dev3-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

Details for the file nbtoolbelt-2017.10.dev3.tar.gz.

File metadata

File hashes

Hashes for nbtoolbelt-2017.10.dev3.tar.gz
Algorithm Hash digest
SHA256 02962ef9c93e0186957d146562a084b315854432147edb205302c433ed17a399
MD5 00d9a3bc0478cb6cb0813e0c7f42f57d
BLAKE2b-256 b6a8d103d783415a21e5faff9ab776bf684d7781a74a4fbb5803d035ae813962

See more details on using hashes here.

File details

Details for the file nbtoolbelt-2017.10.dev3-py3-none-any.whl.

File metadata

File hashes

Hashes for nbtoolbelt-2017.10.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 8ea6e9242063bdd20c97dc3f993871aa77277cecb5425bd54530dea3038edf4e
MD5 88da15e24baf04369285bf48a5346562
BLAKE2b-256 4042f3cb77b34cd8a29a534123e0c43199497377e4d15a0ad3e80df7186a3d4f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page