Skip to main content

Image Processing Library For Robot Framework

Project description


ImageLibrary is designed to automate cases involving various types of screen processing with RoboFramework.

It operates with:

  • OpenCV
  • PIL
  • TesseractOCR


pip install robotframework-imagelibrary


Keyword documentation

Search for lates 0.2.0 version before big refactoring on

Buttons guide

Buttons documentation

Installation Requirements

  • Important info *

Image Library MUST be initialized in Suite Setup before use by calling the keyword Init with specified arguments (see docs).

When Init is called library reads the yaml config and tries to locate given templates images (png files) in the provided dir with stored screenshots. If any name is not found library will throw and error.

If all the data is correct library memorizes it and creates keyword objects (templates, buttons, zones) to use them in Keywords call. This helps to pass to Keyword desired arguments just as names to make them more readable.

All the objects are destroyed when test execution is complete.


Implement the ImageLibrary into robot test suite file with specifying (optional) the output directory to store screenshots.

If directory not specified - execution dir is used.


Library ImageLibrary screenshot_folder=${CURDIR}${/}output

Create the yaml config file (read from Keyword documentation) and specify windows and its

contents: zones, templates, buttons and window existence criteria.

Call in Keywords window contents by its name.


${is_on_screen} = Is Template On Screen template=gummi Wait For Window - main window supposed to be called and mustn't be passed as argument Wait For Show window=settings ${num} = Get Number From Zone zone=price resize_after=30 contrast=1

Zones Coordinates are taken in such format [x, y, w, h]: [123, 34, 12, 10]

 | x - from the top left corner of the desired window

 | y - top position from the desired window

 | w - width

 | h - height

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robotframework-imagelibrary-1.0.1.tar.gz (44.2 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page