Skip to main content

ImageHorizonLibrary

This Robot Framework library provides the facilities to automate GUIs based on image recognition similar to Sikuli. This library wraps pyautogui to achieve this.

For non pixel perfect matches, there is a feature called confidence level that comes with a dependency OpenCV (python package: opencv-python). This functionality is optional - you are not required to install opencv-python package if you do not use confidence level.

Keyword documentation

Keyword Documentation

Travis CI

Travis CI

https://travis-ci.org/Eficode/robotframework-imagehorizonlibrary.svg?branch=master

Prerequisites

On Ubuntu, you need to take special measures to make the screenshot functionality to work correctly. The keyboard functions might not work on Ubuntu when run in VirtualBox on Windows.

Development

Installation

If you have pip, installation is straightforward:

$ pip install robotframework-imagehorizonlibrary

This will automatically install dependencies as well as their dependencies.

Windows

ImageHorizonLibrary should work on Windows “out-of-the-box”. Just run the commands above to install it.

OSX

NOTICE ImageHorizonLibrary does not currently work with XCode v.8. Please use a previous version.

You additionally need to install these for pyautogui:

$ pip install pyobjc-core pyobjc

For these, you need to install XCode

Linux

You additionally need to install these for pyautogui:

$ sudo apt-get install python-dev python-xlib

You might also need, depending on your Python distribution, to install:

$ sudo apt-get install python-tk

If you are using virtualenv, you must install python-xlib manually to the virtual environment for pyautogui:

$ pip install python-xlib-<latest version>.tar.gz

Running unit tests

$ python tests/utest/run_tests.py [verbosity=2]

Running acceptance tests

Additionally to unit test dependencies, you also need OpenCV, Eel, scrot and Chrome/Chromium browser. OpenCV is used because this tests are testing also confidence level. Browser is used by Eel for cross-platform GUI demo application. scrot is used for capturing screenshots.

::

$ pip install opencv-python eel

To run tests, run this command:

$ python tests/atest/run_tests.py

Updating Docs

To regenerate documentation (doc/ImageHorizonLibrary.html), use this command:

$ python -m robot.libdoc -P ./src ImageHorizonLibrary doc/ImageHorizonLibrary.html

Metadata

Release files for robotframework-imagehorizonlibrary 1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for robotframework-imagehorizonlibrary 1.0
File Size Uploaded Provenance Actions
robotframework-imagehorizonlibrary-1.0.tar.gz 14.8 kB Without provenance Details for robotframework-imagehorizonlibrary-1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for robotframework-imagehorizonlibrary 1.0
File Interpreter ABI Platform Actions
robotframework_imagehorizonlibrary-1.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for robotframework_imagehorizonlibrary-1.0-py2.py3-none-any.whl

Total release size: 30.9 kB

Release files / robotframework-imagehorizonlibrary-1.0.tar.gz

Download URL robotframework-imagehorizonlibrary-1.0.tar.gz
Size 14.8 kB
Tags Source
SHA-256 checksum
How to use checksums
5a530ca9850565fa679ebca9697de32bd2bd7cff702a12a41efd069918068358
BLAKE2b-256 checksum
How to use checksums
a99bb79b00b1ac54c5e9c07ef4d0e42b4c88e98fa070d2039823d43aae947ecb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

Release files / robotframework_imagehorizonlibrary-1.0-py2.py3-none-any.whl

Download URL robotframework_imagehorizonlibrary-1.0-py2.py3-none-any.whl
Size 16.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
90edf08601b7d2800b6958486ce4359edf2a666778f27e39fc9020fc8ba4488b
BLAKE2b-256 checksum
How to use checksums
bf902a88b0af6d6b94851450f89881ead4b173ac3dc79c8ab87ce7c181a4cb8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

Security for robotframework-imagehorizonlibrary 1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page