Pytest plugin for testing notebooks
Project description
nbmake
What? Pytest plugin for testing and releasing notebook documentation
Why? To raise the quality of scientific material through better automation
Who is this for? Research/Machine Learning Software Engineers who maintain packages/teaching materials with documentation written in notebooks.
Functionality
- Executes notebooks using pytest and nbclient, allowing parallel notebook testing
- Optionally writes back to the repo, allowing faster building of nbsphinx or jupyter book docs
- Optionally builds an HTML report using jupyter-book of the test run which can be uploaded to hosting providers such as Netlify.
See docs to get started.
See Also
HTML Report Example
Developing
Install local package
poetry install -E html
Activate shell
poetry shell
Run static checks
pre-commit run --all-files
pre-commit install
Run tests
pytest
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
nbmake-0.2.tar.gz
(10.0 kB
view hashes)
Built Distribution
nbmake-0.2-py3-none-any.whl
(11.2 kB
view hashes)
