Registry / testing / robotframework-appiumlibrary

robotframework-appiumlibrary

JSON →
library3.2.1pypypiunverified

Robot Framework Appium Library is a mobile app testing library for Robot Framework, enabling test automation for Android and iOS applications. It acts as an Appium client, communicating with the Appium server to control mobile devices, similar to how Selenium WebDriver interacts with web browsers. The library is actively maintained, with frequent updates, including recent major versions that bring compatibility with newer Python, Appium Python Client, Selenium, and Robot Framework versions.

pip install robotframework-appiumlibrary
INSTALL
IMPORT
SIG · ROBOTFRAMEWORK-APP
R
robotframework-appiumlibrary
testingpythonv3.2.1
Install
4.9s avg
Import
Disk
69MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v3.2.1 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.920 runs
installs and imports cleanly · install 0.0s · import 0.000s · 68.6MB
glibc
py 3.103.920 runs
installs and imports cleanly · install 4.9s · import 0.000s · 69MB
69MB installed
● package 69MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

AppiumLibrary
*** Settings *** Library AppiumLibrary
Imported in the 'Settings' section of a Robot Framework test file.

This Robot Framework example demonstrates opening and closing a sample Android application using AppiumLibrary. Before running, ensure an Appium server is running (e.g., on http://127.0.0.1:4723) and a compatible Android emulator/device is set up with developer options enabled. The `ANDROID_APP` variable should point to your application's `.apk` file. The `Open Application` keyword initializes the session with desired capabilities.

*** Settings *** Documentation Simple example using AppiumLibrary. Library AppiumLibrary *** Variables *** ${APPIUM_SERVER_URL} http://127.0.0.1:4723/wd/hub ${ANDROID_AUTOMATION_NAME} UIAutomator2 ${ANDROID_PLATFORM_NAME} Android ${ANDROID_PLATFORM_VERSION} %{ANDROID_PLATFORM_VERSION=11} # Example: read from ENV or default to 11 ${ANDROID_APP} ${CURDIR}/demoapp/ApiDemos-debug.apk # Replace with your app path *** Test Cases *** Should Open And Close Test Application Open Test Application Sleep 3s Close Application *** Keywords *** Open Test Application Open Application ${APPIUM_SERVER_URL} ... automationName=${ANDROID_AUTOMATION_NAME} ... platformName=${ANDROID_PLATFORM_NAME} ... platformVersion=${ANDROID_PLATFORM_VERSION} ... app=${ANDROID_APP} ... appPackage=io.appium.android.apis ... appActivity=.app.SearchInvoke
Debug
Known issues
breakingKeywords like `Reset Application`, `Element Name Should Be`, `Element Value Should Be`, `Zoom`, and `Long Press` were removed in AppiumLibrary v3.2.1/v3.2. Existing tests using these will fail.
fix
Migrate to new assertion keywords like `Expect Element` and `Expect Text` (replacing `Element Should Be Enabled/Disabled/Visible`, `Text Should Be Visible`). For element attribute checks, use `Element Attribute Should Match`. For `Long Press`, the `Tap` keyword now supports a time parameter.
affects: >=3.2.0
breakingAppiumLibrary v3.0.0 removed several keywords including `Click A Point`, `Click Element At Coordinates`, `Launch Application`, `Quit Application`, `Background App`, `Click Button`, and `Pinch`. The `Swipe` keyword now strictly requires named arguments.
fix
Replace removed keywords with their modern alternatives (e.g., `Click Button` -> `Click Element`). For `Launch Application` and `Quit Application`, consider `Activate Application` and `Close Application` respectively. Adjust `Swipe` calls to use named arguments.
affects: >=3.0.0
breakingIn AppiumLibrary v2.0.0, `TouchAction` keywords were deprecated, and application management keywords like `launch_application`, `quit_application`, `reset_application` were deprecated/renamed (`Activate App` to `Activate Application`, etc.) to align with Appium Python Client changes.
fix
Refactor tests to use newer W3C ActionChain-based keywords for complex gestures and adopt the renamed application management keywords. For newer AppiumLibrary versions (v3.0.0+), `TouchAction` based keywords are completely removed.
affects: >=2.0.0, <3.0.0
gotchaUsing older `robotframework-appiumlibrary` versions (pre-3.0.0) with `Appium-Python-Client==4.0.0` or higher can lead to `ModuleNotFoundError: No module named 'appium.webdriver.common.touch_action'` errors due to changes in the underlying Appium Python Client.
fix
Upgrade `robotframework-appiumlibrary` to version 3.0.0 or later, as it addresses this incompatibility. Alternatively, downgrade `Appium-Python-Client` to a version less than 4.0.0 (e.g., `pip install --force-reinstall "Appium-Python-Client<4.0.0"`).
affects: <3.0.0
Upgrade
Version history
3.2.1latest on PyPI · released Dec 15, 2025
Audit
Dependencies
pythonrequiredRequired for running Robot Framework and the library.
robotframeworkrequiredThe core test automation framework.
Appium-Python-ClientrequiredPython client for Appium, used for communicating with the Appium server.
seleniumrequiredUnderlying WebDriver capabilities are leveraged by Appium.
Agent activity
8 hits · last 30 days
node
6
Resources
robotframework-appiumlibrary — pip install robotframework-appiumlibrary · libregistry