Skip to content

GettingStarted

Jump to bottom
Karl-Michael Schneider edited this page Sep 27, 2015 · 8 revisions

Introduction

RGUILS (Robust GUI automation Library for Sikuli, pronounced as rogels or ragils) is a python library that provides an object-oriented API to interact with common GUI elements, such as buttons, checkboxes, windows and dialogue hierarchies. RGUILS uses Sikuli Script to interact with GUIs. RGUILS has been designed to make GUI automation and testing easier and more robust.

To learn more about Sikuli, read the Sikuli overview. To learn how to use RGUILS, read the SampleInstaller tutorial. For a more in-depth discussion of GUI automation issues, read the article about robust GUI automation.

Installation

The following instructions are for Windows:

  1. Download and install Sikuli from http://sikuli.org/
  2. Create a folder for Sikuli projects. RGUILS assumes that this folder is called Sikuli and is located in your home directory (C:\Documents and Settings\{username}\Sikuli in Windows XP, C:\Users\{username}\Sikuli in Windows Vista and 7).
  3. Check out RGUILS and put the contents of the src/python folder (seagull, sikuliimport) into your Sikuli projects folder.
  4. Copy the following files from the resources folder to the Sikuli IDE installation folder (C:\Program Files\Sikuli): sikuli-script.bat, sikuli-shell.bat, userlib.py
  5. If your Sikuli projects folder is not in the default location (see above), edit userlib.py in the Sikuli IDE installation folder and set the USERLIBDIR variable to point to your Sikuli projects folder.

Running

The sikuli-script.bat Windows batch file can be used to run a Sikuli script file from the command line. Simply open a command prompt, cd into your Sikuli projects folder and type the command:

C:\Documents and Settings\username\Sikuli>"\Program Files\Sikuli\sikuli-script.bat" foo.sikuli

For more information see the Sikuli overview.

List of RGUILS modules

  • Buttons: classes to model sets of buttons
  • Checkboxes: classes to model sets of checkboxes and radio buttons
  • DialogueWindow: classes to model dialogue window hierarchies
  • Images: creates dictionary objects with button images imported from Sikuli projects
  • OverlayWindow: classes to display overlay windows for debugging
  • Util: utility functions and classes
  • Window: an object-oriented API to interact with application windows
  • WindowFlavor: OS specific window properties
  • WindowsXP: definitions for Windows XP
  • WindowsVista: definitions for Windows Vista
  • Windows7: definitions for Windows 7
  • WindowsUtil: utility functions for Windows operating systems
  • SikuliImport: import images and other symbols from Sikuli projects
Clone this wiki locally