Skip to main content

Appium Library


AppiumLibrary is an appium testing library for Robot Framework. Library can be downloaded from PyPI.
It uses Appium to communicate with Android and iOS application similar to how Selenium WebDriver talks to web browser.
It is supporting Python 3.7+ (since Appium Python Client doesn't support Python 2.7 anymore)

Tutorial Videos about RF and Appium

Link to Playlist:

Keyword Documentation

See Keyword Documentation for available keywords and more information about the library in general.


Install with pip:

pip install robotframework-appiumlibrary

Device Setup

After installing the library, you still need to setup an simulator/emulator or real device to use in tests. iOS and Android have separate paths to follow, and those steps better explained in Appium Driver Setup Guide. Please follow the Driver-Specific Setup according to platform.


*** Settings ***
Documentation Simple example using AppiumLibrary
Library AppiumLibrary

*** Variables ***
${ANDROID_APP} ${CURDIR}/demoapp/ApiDemos-debug.apk

*** Test Cases ***
Should send keys to search box and then check the value
Open Test Application
Input Search Query Hello World!
Submit Search
Search Query Should Be Matching Hello World!

*** Keywords ***
Open Test Application
Open Application automationName=${ANDROID_AUTOMATION_NAME}
... app=${ANDROID_APP}

Input Search Query
[Arguments] ${query}
Input Text txt_query_prefill ${query}

Submit Search
Click Element btn_start_search

Search Query Should Be Matching
[Arguments] ${text}
Wait Until Page Contains Element android:id/search_src_text
Element Text Should Be android:id/search_src_text ${text}