pytest-nbsmoke 0.1.0

Requirements

• pytest >= 3.1.1

• jupyter_client

• ipykernel

• nbformat

• nbconvert

• pyflakes

Installation

You can install “pytest-nbsmoke” via pip from PyPI:

$ pip install pytest-nbsmoke

Usage

Check all notebooks in examples/ run without errors:

$ pytest --nbsmoke-run examples/

Check all notebooks in examples/ run without errors, and store html to look at afterwards:

$ pytest --nbsmoke-run --store-html=/scratch examples/

Lint check notebooks in examples/:

$ pytest --nbsmoke-lint notebooks/

Instead of all files in a directory, you can specify a list e.g.:

$ pytest --nbsmoke-lint notebooks/Untitled*.ipynb

Additional options are available by standard pytest ‘ini’ configuration in setup.cfg, pytest.ini, or tox.ini:

[pytest]
it_is_nb_file = ^.*\.something$   # case insensitive re to match for file to be considered notebook; defaults to ``^.*\.ipynb``
cell_timeout = 600                # seconds allowed per cell (see nbconvert timeout)

Contributing

First, install using pip install -e .. Then run the tests using tox or pytest -v tests/.

License

Distributed under the terms of the BSD-3 license, “pytest-nbsmoke” is free and open source software.

Issues

If you encounter any problems, please file an issue (ideally including a copy of any problematic notebook).