Basic notebook checks. Do they run? Do they contain lint?
Basic notebook smoke tests: Do they run ok? Do they contain lint?
WARNING: early stage proof of concept; work in progress. Use at your own risk.
Created with a cookiecutter and modified until it seemed to work. There’s loads of cleanup left to do (and boilerplate to remove).
- pytest >= 3.1.1
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] # when running, seconds allowed per cell (see nbconvert timeout) cell_timeout = 600 # notebooks to skip running; one case insensitive re to match per line skip_run = ^.*skipme\.ipynb$ ^.*skipmetoo.*$ # case insensitive re to match for file to be considered notebook; # defaults to ``^.*\.ipynb`` it_is_nb_file = ^.*\.something$
First, install using pip install -e .. Then run the tests using tox or pytest -v tests/.
New release to PyPI: git tag -a x.y.z -m "Something about release" && git push --tags.
Distributed under the terms of the BSD-3 license, “pytest-nbsmoke” is free and open source software.
If you encounter any problems, please file an issue (ideally including a copy of any problematic notebook).
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size pytest_nbsmoke-0.1.1-py2.py3-none-any.whl (7.1 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size pytest-nbsmoke-0.1.1.tar.gz (27.5 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for pytest_nbsmoke-0.1.1-py2.py3-none-any.whl