Skip to main content

A simple image diff plugin for pytest

Project description

pytest-Inomaly
===================================

[![Build Status](https://ci.digitaloctave.com/api/badges/oly/pytest-inomaly/status.svg)](https://ci.digitaloctave.com/oly/pytest-inomaly)

A simple image diff plugin for pytest currently provides two new methods, use full for testing image related code and making sure the results do not change unexpectedly.

- pytest.idiff - returns true or false
- pytest.idiff_variance - returns the difference between the two images


Requirements
------------
Requires scipy and pytest to calculate the differences.

- scipy
- pytest


Installation
------------

You can install "pytest-Inomaly" via `pip`_ from `PyPI`_::

$ pip install pytest-Inomaly


Usage
-----


Assert images are identical.

assert idiff(path_to_first_image, path_to_second_image) is True

Assert images are almost identical, allow some variation for anti aliasing or similar.

assert idiff(path_to_first_image, path_to_second_image, tolerance=0.1) is True

Same as the above two method but will return the difference as a value instead of true or false.

assert idiff_tolerance(path_to_first_image, path_to_second_image, tolerance=0.1) == 3.14


Contributing
------------
Contributions are very welcome. Tests can be run with `tox`_, please ensure
the coverage at least stays the same before you submit a pull request.

License
-------

Distributed under the terms of the `MIT`_ license, "pytest-Inomaly" is free and open source software


Issues
------

If you encounter any problems, please `file an issue`_ along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-Inomaly-0.2.3.tar.gz (3.8 kB view details)

Uploaded Source

File details

Details for the file pytest-Inomaly-0.2.3.tar.gz.

File metadata

File hashes

Hashes for pytest-Inomaly-0.2.3.tar.gz
Algorithm Hash digest
SHA256 15f288c3805467ea39ac2804dc2cf8e429d5a1579962b01d886275ba62571c24
MD5 af19d22a206943d2223de3f030856c9d
BLAKE2b-256 8ff50ed782fd0fe70e9e5c678b85c86daaab91d8cac5920285d513442cb9994d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page