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

Documentation is available on Read the Docs.

On the command line, you can use the options -h or --help.

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.dev5.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for nbtoolbelt-2017.10.dev5.tar.gz
Algorithm Hash digest
SHA256 026fcd6f8e74855279782b5051fa02b9c93a36b22e1aea62626b935193fead5d
MD5 2e236f64d8c6b1bf4b0a69eca10cf7c5
BLAKE2b-256 af9807166fc51190bb15f1991f791874a78bf87640717f07d648acbed5c9312f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbtoolbelt-2017.10.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 68894355471ca66f511f16c92cb45b77db1605d3b4ac585cd754fb61a9eebcd9
MD5 90ecb7265b8c19fe31f67f4a68acd689
BLAKE2b-256 e8267e3b5f0ec55d321d874af5c203202dab1ed8a61f08e56455d05e51694e7a

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