nbval
A pytest plugin that validates Jupyter notebooks by executing cells and comparing outputs to ensure consistency.
What is nbval?
nbval is a pytest plugin that validates Jupyter notebooks by executing their code cells and comparing the outputs with the stored results. It ensures notebooks run without errors and produce consistent outputs, which is crucial for maintaining reliable documentation, tutorials, and reproducible research. The plugin integrates seamlessly into pytest workflows, allowing developers to treat notebooks as testable artifacts.
Data scientists, researchers, and developers who use Jupyter notebooks for documentation, tutorials, or reproducible research and need to ensure their notebooks execute correctly and produce consistent outputs over time.
nbval provides a specialized testing framework for Jupyter notebooks, offering flexible validation modes, output sanitization, and integration with pytest ecosystems like coverage and parallel execution. It addresses the unique challenge of testing notebooks as executable documents, ensuring reliability without manual checks.
Overview
A py.test plugin to validate Jupyter notebooks
Use Cases
Best For
- Validating tutorial or documentation notebooks to ensure they run without errors
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
