Metadata-Version: 2.1
Name: images-compare
Version: 0.6.0
Summary: This Python package allows for image comparison between two provided images using a specified threshold
Home-page: https://github.com/denzilrdz/images-compare
Author: Denzil Rodrigues
Author-email: denzil.rdz@gmail.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt


# Images Compare 🖼️

This Python package allows for image comparison between two provided images using a specified threshold.




## Installation

Install images-compare with pip

```bash
pip install images-compare
```
    
## Demo

Copy the below code snippet for a quick start

```python
from images_compare import verify_images

res = verify_images("img_1.png", "img_2.png", 0.0001)
print(res)
```

## Usage

The function `verify_images` is designed to take three parameters: the first two parameters are the images to be compared, and the third parameter represents the threshold difference. The default value for the threshold is set to 0.0001.

## Authors

[Denzil Rodrigues](https://denzilrdz.github.io/denzilrodrigues/)


## License

[MIT](https://choosealicense.com/licenses/mit/)

