Metadata-Version: 2.1
Name: monkey-vision
Version: 0.1.2
Summary: Computer vision image analyses for monkey screenshots.
Home-page: https://github.com/monkey-cli/monkey_vision
Author: Valdio Veliu <Valdio Veliu>
Author-email: valdioveliu@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.18.0)
Requires-Dist: opencv-python (>=4.4.0)
Requires-Dist: pytesseract (==0.3.6)
Provides-Extra: dev
Requires-Dist: pre-commit (==2.7.1) ; extra == 'dev'
Requires-Dist: matplotlib (==3.3.1) ; extra == 'dev'

# monkey-vision

```bash
##################################
###        monkey vision       ###
##################################
```

Computer vision image analyses for monkey screenshots.
This module can analyze app screenshots and provide information about all the intractable components in the image.

# Install

Install the package. If you prefer you can use a virtual environment. **(Check [docs/README.md](/docs/README.md))**

```bash
 $ pip install monkey_vision
```

To get a specific version or to check for updates please refer to the [Links](#Links) section.

# Exposed api

1. Image analysis, get image event point.
Will return the list of possible interaction coordinates (event points) visible in the provided screenshot.

```bash
 $ monkey_vision -r imagePath
 $ monkey_vision --run imagePath
```

2. Percentage compare between two images:
Will return an array of the percentage comparison of the base image, the first argument, with the rest of the arguments.

```bash
 $ monkey_vision -m imagePath1 imagePath2 ... imagePathN
 $ monkey_vision --match imagePath1 imagePath2 ... imagePathN
```

3. Percentage compare between two images focusing on a particular area of the image.
This functionality works similarly to the normal percentage compare.
The first argument of the focused percentage match is the center coordinate of the comparison area.

```bash
 $ monkey_vision -fm XX YY imagePath1 imagePath2 ... imagePathN
 $ monkey_vision --focusedMatch XX YY imagePath1 imagePath2 ... imagePathN
```

4. Help:
```bash
 $ monkey_vision -h
 $ monkey_vision --help
```


# Links

- Production releases are published at [PyPI](https://pypi.org/project/monkey-vision/).
- For test or/and unstable versions check out [TestPyPI](https://test.pypi.org/project/monkey-vision/).


