pytest-mpl 0.1.dev183+g2b1b8d7 documentation

pytest-mpl is a pytest plugin to facilitate image comparison for Matplotlib figures.

For each figure to test, an image is generated and then subtracted from an existing reference image. If the RMS of the residual is larger than a user-specified tolerance, the test will fail. Alternatively, the generated image can be hashed and compared to an expected value.

Installation

Install using pip:

pip install pytest-mpl

Install from conda-forge using conda:

conda install pytest-mpl

Further details are available in the Installation Guide.

Learning resources

Tutorials

• Get started

How-tos

• Image comparison mode

• Hash comparison mode

• Hybrid mode

Understand how pytest-mpl works

Explanatory information is included where relevant throughout the documentation.

Reference

• Configuration

Contributing

pytest-mpl is a community project maintained for and by its users. There are many ways you can help!

• Report a bug or request a feature on GitHub

• Improve the documentation or code