Appium library for RobotFramework
==================================================
Introduction
------------
AppiumLibrary_ is an appium testing library for `Robot Framework`_. Library can be downloaded from PyPI_.
It uses `Appium <http://appium.io/>`_ 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)
.. image:: https://img.shields.io/pypi/v/robotframework-appiumlibrary.svg
:target: https://pypi.python.org/pypi/robotframework-appiumlibrary/
:alt: Latest PyPI version
.. image:: https://img.shields.io/pypi/dm/robotframework-appiumlibrary.svg
:target: https://pypi.python.org/pypi/robotframework-appiumlibrary/
:alt: Number of PyPI downloads
.. contents::
Keyword Documentation
---------------------
See `Keyword Documentation`_ for available keywords and more information about the library in general.
Installation
------------
The recommended installation method is using
`pip <http://pip-installer.org>`__::
pip install --upgrade robotframework-appiumlibrary
See `Robot Framework installation instructions`_ for detailed information
about installing Python and Robot Framework itself.
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.
Usage
-----
To write tests with Robot Framework and AppiumLibrary,
AppiumLibrary must be imported into your RF test suite.
See `Robot Framework User Guide <https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html>`_
for more information.
As it uses Appium make sure your Appium server is up and running.
For how to use Appium please refer to `Appium Documentation <http://appium.io/docs/en/about-appium/getting-started/>`_
When using Robot Framework, it is generally recommended to write tests easy to read/modify.
The keywords provided in AppiumLibrary are pretty low level. It is thus typically a good idea to write tests using
Robot Framework's higher level keywords that utilize AppiumLibrary
keywords internally. This is illustrated by the following example
where AppiumLibrary keywords like ``Input Text`` are primarily
used by higher level keywords like ``Input Search Query``.
.. code:: robotframework
*** Settings ***
Documentation Simple example using AppiumLibrary
Library AppiumLibrary
*** Variables ***
${ANDROID_AUTOMATION_NAME} UIAutomator2
${ANDROID_APP} ${CURDIR}/demoapp/ApiDemos-debug.apk
${ANDROID_PLATFORM_NAME} Android
${ANDROID_PLATFORM_VERSION} %{ANDROID_PLATFORM_VERSION=11}
*** 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 http://127.0.0.1:4723/wd/hub automationName=${ANDROID_AUTOMATION_NAME}
... platformName=${ANDROID_PLATFORM_NAME} platformVersion=${ANDROID_PLATFORM_VERSION}
... app=${ANDROID_APP} appPackage=io.appium.android.apis appActivity=.app.SearchInvoke
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}
Create a file with the content above (name it: ``test_file.robot``) and execute::
robot test_file.robot
The above example is single file test case, more examples can be found in a `sample project`_ that illustrates using
Robot Framework and AppiumLibrary. Check the sample project that you can find examples of mobile web & ios & android.
Contributing
-------------
Fork the project, make a change, and send a pull request!
Project Contributors
--------------------
* `Serhat Bolsu <https://github.com/serhatbolsu>`_
* `William Zhang <https://github.com/jollychang>`_
* `Xie Lieping <https://github.com/frankbp>`_
* `Jari Nurminen <https://github.com/yahman72>`_
AppiumLibrary is modeled after (and forked from) `appiumandroidlibrary <https://github.com/frankbp/robotframework-appiumandroidlibrary>`_, but re-implemented to use appium 1.X technologies.
.. _AppiumLibrary: https://github.com/serhatbolsu/robotframework-appiumlibrary
.. _Robot Framework: https://robotframework.org
.. _Keyword Documentation: http://serhatbolsu.github.io/robotframework-appiumlibrary/AppiumLibrary.html
.. _PyPI: https://pypi.org/project/robotframework-appiumlibrary/
.. _Robot Framework installation instructions: https://github.com/robotframework/robotframework/blob/master/INSTALL.rst
.. _Appium Driver Setup Guide: http://appium.io/docs/en/about-appium/getting-started/?lang=en
.. _sample project: https://github.com/serhatbolsu/robotframework-appium-sample
Raw data
{
"_id": null,
"home_page": "https://github.com/serhatbolsu/robotframework-appiumlibrary",
"name": "robotframework-appiumlibrary",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "robotframework testing testautomation mobile appium webdriver app android ios",
"author": "Serhat Bolsu, William Zhang, Xie Lieping, Jari Nurminen",
"author_email": "serhatbolsu@gmail.com,jollychang@gmail.com,frankbp@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fe/33/f7ab3051e8075445c790e90cca35afe54ac983dbb82b65fc7c4c970f4acc/robotframework-appiumlibrary-2.0.0.tar.gz",
"platform": "any",
"description": "Appium library for RobotFramework\n==================================================\n\nIntroduction\n------------\n\nAppiumLibrary_ is an appium testing library for `Robot Framework`_. Library can be downloaded from PyPI_.\n\nIt uses `Appium <http://appium.io/>`_ to communicate with Android and iOS application\nsimilar to how *Selenium WebDriver* talks to web browser.\n\nIt is supporting Python 3.7+ (since Appium Python Client doesn't support Python 2.7 anymore)\n\n.. image:: https://img.shields.io/pypi/v/robotframework-appiumlibrary.svg\n :target: https://pypi.python.org/pypi/robotframework-appiumlibrary/\n :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/pypi/dm/robotframework-appiumlibrary.svg\n :target: https://pypi.python.org/pypi/robotframework-appiumlibrary/\n :alt: Number of PyPI downloads\n\n\n.. contents::\n\n\nKeyword Documentation\n---------------------\n\nSee `Keyword Documentation`_ for available keywords and more information about the library in general.\n\n\nInstallation\n------------\n\nThe recommended installation method is using\n`pip <http://pip-installer.org>`__::\n\n pip install --upgrade robotframework-appiumlibrary\n\n\nSee `Robot Framework installation instructions`_ for detailed information\nabout installing Python and Robot Framework itself.\n\nDevice Setup\n------------\nAfter installing the library, you still need to setup an simulator/emulator or real device to use in tests.\niOS and Android have separate paths to follow, and those steps better explained in `Appium Driver Setup Guide`_.\nPlease follow the **Driver-Specific Setup** according to platform.\n\n\nUsage\n-----\n\nTo write tests with Robot Framework and AppiumLibrary, \nAppiumLibrary must be imported into your RF test suite.\nSee `Robot Framework User Guide <https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html>`_\nfor more information.\n\nAs it uses Appium make sure your Appium server is up and running.\nFor how to use Appium please refer to `Appium Documentation <http://appium.io/docs/en/about-appium/getting-started/>`_\n\nWhen using Robot Framework, it is generally recommended to write tests easy to read/modify.\nThe keywords provided in AppiumLibrary are pretty low level. It is thus typically a good idea to write tests using\nRobot Framework's higher level keywords that utilize AppiumLibrary\nkeywords internally. This is illustrated by the following example\nwhere AppiumLibrary keywords like ``Input Text`` are primarily\nused by higher level keywords like ``Input Search Query``.\n\n.. code:: robotframework\n\n *** Settings ***\n Documentation Simple example using AppiumLibrary\n Library AppiumLibrary\n\n *** Variables ***\n ${ANDROID_AUTOMATION_NAME} UIAutomator2\n ${ANDROID_APP} ${CURDIR}/demoapp/ApiDemos-debug.apk\n ${ANDROID_PLATFORM_NAME} Android\n ${ANDROID_PLATFORM_VERSION} %{ANDROID_PLATFORM_VERSION=11}\n\n *** Test Cases ***\n Should send keys to search box and then check the value\n Open Test Application\n Input Search Query Hello World!\n Submit Search\n Search Query Should Be Matching Hello World!\n\n\n *** Keywords ***\n Open Test Application\n Open Application http://127.0.0.1:4723/wd/hub automationName=${ANDROID_AUTOMATION_NAME}\n ... platformName=${ANDROID_PLATFORM_NAME} platformVersion=${ANDROID_PLATFORM_VERSION}\n ... app=${ANDROID_APP} appPackage=io.appium.android.apis appActivity=.app.SearchInvoke\n\n Input Search Query\n [Arguments] ${query}\n Input Text txt_query_prefill ${query}\n\n Submit Search\n Click Element btn_start_search\n\n Search Query Should Be Matching\n [Arguments] ${text}\n Wait Until Page Contains Element android:id/search_src_text\n Element Text Should Be android:id/search_src_text ${text}\n\nCreate a file with the content above (name it: ``test_file.robot``) and execute::\n\n robot test_file.robot\n\nThe above example is single file test case, more examples can be found in a `sample project`_ that illustrates using\nRobot Framework and AppiumLibrary. Check the sample project that you can find examples of mobile web & ios & android.\n\nContributing\n-------------\nFork the project, make a change, and send a pull request!\n\nProject Contributors\n--------------------\n* `Serhat Bolsu <https://github.com/serhatbolsu>`_\n* `William Zhang <https://github.com/jollychang>`_\n* `Xie Lieping <https://github.com/frankbp>`_\n* `Jari Nurminen <https://github.com/yahman72>`_\n\nAppiumLibrary is modeled after (and forked from) `appiumandroidlibrary <https://github.com/frankbp/robotframework-appiumandroidlibrary>`_, but re-implemented to use appium 1.X technologies.\n\n\n.. _AppiumLibrary: https://github.com/serhatbolsu/robotframework-appiumlibrary\n.. _Robot Framework: https://robotframework.org\n.. _Keyword Documentation: http://serhatbolsu.github.io/robotframework-appiumlibrary/AppiumLibrary.html\n.. _PyPI: https://pypi.org/project/robotframework-appiumlibrary/\n.. _Robot Framework installation instructions: https://github.com/robotframework/robotframework/blob/master/INSTALL.rst\n.. _Appium Driver Setup Guide: http://appium.io/docs/en/about-appium/getting-started/?lang=en\n.. _sample project: https://github.com/serhatbolsu/robotframework-appium-sample\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Robot Framework Mobile app testing library for Appium Client Android & iOS & Web",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/serhatbolsu/robotframework-appiumlibrary"
},
"split_keywords": [
"robotframework",
"testing",
"testautomation",
"mobile",
"appium",
"webdriver",
"app",
"android",
"ios"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab8262025a310cf3f6ec7c960796aa42847636458232c25e0c693956500d976e",
"md5": "82e029c29d821b9069e7d4cbf78478b6",
"sha256": "4f7ee4919fdf1406cce3203277ad21d456a8feb905a8754f6830958761891b22"
},
"downloads": -1,
"filename": "robotframework_appiumlibrary-2.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "82e029c29d821b9069e7d4cbf78478b6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 37621,
"upload_time": "2022-11-01T11:48:13",
"upload_time_iso_8601": "2022-11-01T11:48:13.929674Z",
"url": "https://files.pythonhosted.org/packages/ab/82/62025a310cf3f6ec7c960796aa42847636458232c25e0c693956500d976e/robotframework_appiumlibrary-2.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe33f7ab3051e8075445c790e90cca35afe54ac983dbb82b65fc7c4c970f4acc",
"md5": "9935a4bd74a6d0dfc3677164405a45a1",
"sha256": "5649acaaf900e9e88cd8f5e90986941011dbec2f648b52941fe4d82a735eba1f"
},
"downloads": -1,
"filename": "robotframework-appiumlibrary-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9935a4bd74a6d0dfc3677164405a45a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31912,
"upload_time": "2022-11-01T11:48:15",
"upload_time_iso_8601": "2022-11-01T11:48:15.642628Z",
"url": "https://files.pythonhosted.org/packages/fe/33/f7ab3051e8075445c790e90cca35afe54ac983dbb82b65fc7c4c970f4acc/robotframework-appiumlibrary-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-01 11:48:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "serhatbolsu",
"github_project": "robotframework-appiumlibrary",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "robotframework-appiumlibrary"
}
JSON
