Metadata-Version: 1.1
Name: robotframework-appiumlibrary
Version: 1.6.3
Summary: Robot Framework Mobile app testing library for Appium Client Android & iOS & Web
Home-page: https://github.com/serhatbolsu/robotframework-appiumlibrary
Author: Serhat Bolsu, William Zhang, Xie Lieping, Jari Nurminen
Author-email: serhatbolsu@gmail.com,jollychang@gmail.com,frankbp@gmail.com
License: Apache License 2.0
Description: 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
Keywords: robotframework testing testautomation mobile appium webdriver app android ios
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
