Skip to main content

Tools to work with Jupyter notebooks

Project description

nbtoolbelt - Tools to Work with Jupyter Notebooks

  • 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: concatenate 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 -r -s
    • create source distribution and wheel: python setup.py sdist bdist_wheel
  • In nbtoolbelt/dist/

    • create digital signature: gpg --detach-sign -a ...
    • upload to PyPI: twine upload ...
  • In nbtoolbelt/src/,

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

Steps to add a feature:

  1. Add issue.

  2. Design interface.

    1. Add (failing) test cases in nbtoolbelt/test/.

    2. Add documentation in nbtoolbelt/docs/.

  3. Implement feature in nbtoolbelt/src/nbtoolbelt/.

  4. Update nbtoolbelt/src/nbtoolbelt/_version.py.

  5. Update CHANGELOG.rst.

  6. Commit and push changes.

  7. Close issue, indicating commit hash.

License

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

Uploaded Source

Built Distribution

nbtoolbelt-2022.3-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

Details for the file nbtoolbelt-2022.3.tar.gz.

File metadata

  • Download URL: nbtoolbelt-2022.3.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.2

File hashes

Hashes for nbtoolbelt-2022.3.tar.gz
Algorithm Hash digest
SHA256 8d059f08743cc89161e649cffe6eb077fe155f0f34461f5d7c350eda54d14a12
MD5 5bc43785e844ea99f288a40c2434e8fa
BLAKE2b-256 957488daa719cee5f6fc769105e5024062d1941a62967fe244631fe1dab75922

See more details on using hashes here.

File details

Details for the file nbtoolbelt-2022.3-py3-none-any.whl.

File metadata

  • Download URL: nbtoolbelt-2022.3-py3-none-any.whl
  • Upload date:
  • Size: 52.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.2

File hashes

Hashes for nbtoolbelt-2022.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fc653200407b75892beb8250c3c209277699106e3768b51f5d094473322bbe2d
MD5 99aea1acb8f5d762620418c9bd77500f
BLAKE2b-256 e4e34448ff8f539168a44820efaf16b41ec26b4939c7e76ee1cfcbe08ca34b17

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