Metadata-Version: 2.1
Name: python-eyes
Version: 0.0.1
Summary: A package for Automation that compare two images and return if there is a difference between them
Home-page: https://github.com/den-iaremenko/python_eye
Author: Denys Iaremenko
Author-email: denysiaremenko@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/den-iaremenko/python_eye
Project-URL: Funding, https://github.com/den-iaremenko/python_eye
Project-URL: Say Thanks!, https://github.com/den-iaremenko/python_eye
Project-URL: Source, https://github.com/den-iaremenko/python_eye
Project-URL: Tracker, https://github.com/den-iaremenko/python_eye/issues
Keywords: image difference,image comparisonappium,selenium,automation,ui validation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: opencv-python (>=4.2.0.34)
Requires-Dist: loguru (>=0.4.1)

#Python Eye

[![PyPI version](https://badge.fury.io/py/python-eye.svg)](https://badge.fury.io/py/python-eye)
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)

Python package for Automation to compare expected UI on page or Mobile app screen with actual screen.

# Notice

**Since v0.0.1 only Python 3 is supported**

# Getting the Python Eye

1. Install from [PyPi](https://pypi.org), as
['python_eye'](https://pypi.org/project/python-eye/).

```shell
pip install python_eye
```

# Development

- Docstring style: Google Style
    - Refer [link](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)


# Run tests


```
$ pytest
```

You also can run particular tests like below.

```
$ pytest test/unit
```

Run with `pytest-xdist`

```
$ pytest -n 2 test/unit
```

# Usage

```python
from python_eye import PythonEye


eye = PythonEye(driver, "screenshots", "results")
eye.find_difference("screenshot.png")
```

# Build & Release 

```bash
sudo python3.8 setup.py sdist bdist_wheel

twine upload --repository pypi dist/*
```

