guibot

A tool for GUI automation using a variety of computer vision and desktop control backends.

Introduction

In order to do GUI automation you usually need to solve two problems: first, you need to have a way to control and interact with the interface and platform you are automating and second, you need to be able to locate the objects you are interested in on the screen. Guibot helps you do both.

To interact with GUIs, Guibot provides the desktopcontrol module which contains a common interface for different desktop control backends, with methods to move the mouse, take screenshots, type characters and so on. The backend to use will depend on how your interface is accessible, but the ones currently supported are qemu, vnctotool, xdotool, and autopy.

To locate an element on the screen, you will need an image representing the screen, a target and a finder - the finder looks for the target on the image, and returns the coordinates to the region where that target appears. Finders, like desktop controllers, are wrappers around different backends that Guibot supports (see below), while targets are a representation of the object you are looking for, such as images, text, or patterns.

Finally, to bridge the gap between controlling the GUI and finding elements, the region module is provided. It represents a subregion of a screen, and contains methods to locate targets in this region and interact with the graphical interface using the chosen backends.

Supported backends

Supported Computer Vision (CV) backends are based on

  • OpenCV
    • Template matching
    • Contour matching
    • Feature matching
    • Haar cascade matching
    • Template-feature and mixed matching
  • Tesseract OCR
    • Text matching
  • PyTorch
    • CNN matching
  • autopy
    • AutoPy matching

Supported Desktop Control (DC) backends are based on