Metadata-Version: 2.1
Name: visual-compare
Version: 1.0.2.2
Summary: Image and PDF Compare
Home-page: https://github.com/cuidingyong/visual-compare
Author: Dillon
Author-email: cuidingyong@yeah.net
License: MIT
Keywords: visual compare image pdf diff
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown

Visual Compare
==============

## Installation

```commandline
pip install visual-compare
```

## Examples

### Compare images ###

```python
from visual_compare.doc.visual import Visual

def get_path(filename):
    image_base = '../../files/images/'
    return image_base + filename

reference_image = get_path('123.png')
test_image = get_path('124.png')
vt = Visual()
is_diff, res = vt.compare_images(reference_image, test_image)
print(res)
assert is_diff is True
```

 Result as follows

![1.jpg](https://github.com/cuidingyong/visual-compare/raw/main/files/result/1.jpg)

### Compare images with mask ###

```python
from visual_compare.doc.visual import Visual

def get_path(filename):
    image_base = '../../files/images/'
    return image_base + filename

reference_image = get_path('123.png')
test_image = get_path('124.png')
mask_images = [get_path('000.png')]
vt = Visual()
mask = vt.generate_mask(reference_image, mask_images)
is_diff, res = vt.compare_images(reference_image, test_image, mask=mask)
print(res)
assert is_diff is True
```

 Result as follows

![2.jpg](https://github.com/cuidingyong/visual-compare/raw/main/files/result/2.jpg)

### Compare images with OCR ###

```python
from visual_compare.doc.visual import Visual

def get_path(filename):
    image_base = '../../files/images/'
    return image_base + filename

reference_image = get_path('123.png')
test_image = get_path('124.png')
vt = Visual()
is_diff, res = vt.compare_images(reference_image, test_image, force_ocr=True, lang=['ch_sim', 'en'])
print(res)
assert is_diff is True
```

 Result as follows

![3.jpg](https://github.com/cuidingyong/visual-compare/raw/main/files/result/3.jpg)

