Metadata-Version: 2.1
Name: Appium-Python-Client
Version: 2.6.2
Summary: Python client for Appium
Home-page: http://appium.io/
Author: Isaac Murchie
Author-email: isaac@saucelabs.com
Maintainer: Kazuaki Matsuo, Mykola Mokhnach, Mori Atsushi
License: Apache 2.0
Description: # Appium Python Client
        
        [![PyPI version](https://badge.fury.io/py/Appium-Python-Client.svg)](https://badge.fury.io/py/Appium-Python-Client)
        [![Downloads](https://pepy.tech/badge/appium-python-client)](https://pepy.tech/project/appium-python-client)
        
        [![Build Status](https://dev.azure.com/AppiumCI/Appium%20CI/_apis/build/status/appium.python-client?branchName=master)](https://dev.azure.com/AppiumCI/Appium%20CI/_build/latest?definitionId=56&branchName=master)
        
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        An extension library for adding [WebDriver Protocol](https://www.w3.org/TR/webdriver/) and Appium commands to the Selenium Python language binding for use with the mobile testing framework [Appium](https://appium.io).
        
        ## Notice
        
        Since **v1.0.0**, only Python 3.7+ is supported.
        
        Since **v2.0.0**, the base selenium client version is v4.
        The version only works in W3C WebDriver protocol format.
        If you would like to use the old protocol (MJSONWP), please use v1 Appium Python client.
        
        ### Quick migration guide from v1 to v2
        - Enhancement
            - Updated base Selenium Python binding version to v4
                - Removed `forceMjsonwp` since Selenium v4 and Appium Python client v2 expect only W3C WebDriver protocol
            - Methods `ActionHelpers#scroll`, `ActionHelpers#drag_and_drop`, `ActionHelpers#tap`, `ActionHelpers#swipe` and `ActionHelpers#flick` now call W3C actions as its backend
                - Please check each behavior. Their behaviors could slightly differ.
            - Added `strict_ssl` to relax SSL error such as self-signed ones
        - Deprecated
            - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions.
                - e.g.
                    - [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
                    - https://www.selenium.dev/documentation/support_packages/mouse_and_keyboard_actions_in_detail/
                    - https://www.youtube.com/watch?v=oAJ7jwMNFVU
                    - https://appiumpro.com/editions/30-ios-specific-touch-action-methods
                    - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
            - `launch_app`, `close_app` and `reset` are deprecated. Please read [issues#15807](https://github.com/appium/appium/issues/15807) for more details
        
        #### MultiAction/TouchAction to W3C actions
        
        On UIA2, some elements can be handled with `touch` pointer action insead of the default `mouse` pointer action in the Selenium Python cleint.
        For example, the below action builder is to replace the default one with the `touch` pointer action.
        
        ```python
        from selenium.webdriver.common.actions import interaction
        from selenium.webdriver.common.actions.action_builder import ActionBuilder
        
        actions = ActionChains(driver)
        # override as 'touch' pointer action
        actions.w3c_actions = ActionBuilder(driver, mouse=PointerInput(interaction.POINTER_TOUCH, "touch"))
        actions.w3c_actions.pointer_action.move_to_location(start_x, start_y)
        actions.w3c_actions.pointer_action.pointer_down()
        actions.w3c_actions.pointer_action.pause(2)
        actions.w3c_actions.pointer_action.move_to_location(end_x, end_y)
        actions.w3c_actions.pointer_action.release()
        actions.perform()
        ```
        
        ## Getting the Appium Python client
        
        There are three ways to install and use the Appium Python client.
        
        1. Install from [PyPi](https://pypi.org), as
        ['Appium-Python-Client'](https://pypi.org/project/Appium-Python-Client/).
        
            ```shell
            pip install Appium-Python-Client
            ```
        
            You can see the history from [here](https://pypi.org/project/Appium-Python-Client/#history)
        
        2. Install from source, via [PyPi](https://pypi.org). From ['Appium-Python-Client'](https://pypi.org/project/Appium-Python-Client/),
        download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
        
            ```shell
            tar -xvf Appium-Python-Client-X.X.tar.gz
            cd Appium-Python-Client-X.X
            python setup.py install
            ```
        
        3. Install from source via [GitHub](https://github.com/appium/python-client).
        
            ```shell
            git clone git@github.com:appium/python-client.git
            cd python-client
            python setup.py install
            ```
        
        ## Usage
        
        The Appium Python Client is fully compliant with the WebDriver Protocol
        including several helpers to make mobile testing in Python easier.
        
        To use the new functionality now, and to use the superset of functions, instead of
        including the Selenium `webdriver` module in your test code, use that from
        Appium instead.
        
        ```python
        from appium import webdriver
        ```
        
        From there much of your test code will work with no change.
        
        As a base for the following code examples, the following sets up the [UnitTest](https://docs.python.org/3/library/unittest.html)
        environment:
        
        ```python
        # Android environment
        from appium import webdriver
        # Options are only available since client version 2.3.0
        # If you use an older client then switch to desired_capabilities
        # instead: https://github.com/appium/python-client/pull/720
        from appium.options.android import UiAutomator2Options
        from appium.webdriver.common.appiumby import AppiumBy
        
        options = UiAutomator2Options()
        options.platformVersion = '10'
        options.udid = '123456789ABC'
        options.app = PATH('../../../apps/test-app.apk')
        # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
        self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
        el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
        el.click()
        ```
        
        ```python
        # iOS environment
        from appium import webdriver
        # Options are only available since client version 2.3.0
        # If you use an older client then switch to desired_capabilities
        # instead: https://github.com/appium/python-client/pull/720
        from appium.options.ios import XCUITestOptions
        from appium.webdriver.common.appiumby import AppiumBy
        
        options = XCUITestOptions()
        options.platformVersion = '13.4'
        options.udid = '123456789ABC'
        options.app = PATH('../../apps/UICatalog.app.zip')
        # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
        self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
        el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
        el.click()
        ```
        
        ## Direct Connect URLs
        
        If your Selenium/Appium server decorates the new session capabilities response with the following keys:
        
        - `directConnectProtocol`
        - `directConnectHost`
        - `directConnectPort`
        - `directConnectPath`
        
        Then python client will switch its endpoint to the one specified by the values of those keys.
        
        ```python
        from appium import webdriver
        # Options are only available since client version 2.3.0
        # If you use an older client then switch to desired_capabilities
        # instead: https://github.com/appium/python-client/pull/720
        from appium.options.ios import XCUITestOptions
        
        # load_capabilities API could be used to 
        # load options mapping stored in a dictionary
        options = XCUITestOptions().load_capabilities({
            'platformVersion': '13.4',
            'deviceName': 'iPhone Simulator',
            'app': PATH('../../apps/UICatalog.app.zip'),
        })
        
        self.driver = webdriver.Remote(
            # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
            'http://127.0.0.1:4723', 
            options=options, 
            direct_connection=True
        )
        ```
        
        ## Relax SSL validation
        
        `strict_ssl` option allows you to send commands to an invalid certificate host like a self-signed one.
        
        ```python
        from appium import webdriver
        # Options are only available since client version 2.3.0
        # If you use an older client then switch to desired_capabilities
        # instead: https://github.com/appium/python-client/pull/720
        from appium.options.common import AppiumOptions
        
        options = AppiumOptions()
        options.platform_name = 'mac'
        options.automation_name = 'safari'
        # set_capability API allows to provide any custom option
        # calls to it could be chained
        options.set_capability('browser_name', 'safari')
        
        # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
        self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options, strict_ssl=False)
        ```
        
        ## Documentation
        
        - https://appium.github.io/python-client-sphinx/ is detailed documentation
        - [functional tests](test/functional) also may help to see concrete examples.
        
        ## Development
        
        - Code Style: [PEP-0008](https://www.python.org/dev/peps/pep-0008/)
          - Apply `black`, `isort` and `mypy` as pre commit hook
          - Run `make` command for development. See `make help` output for details
        - Docstring style: [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
        - `gitchangelog` generates `CHANGELOG.rst`
        
        ### Setup
        
        - `pip install --user pipenv`
        - `python -m pipenv lock --clear`
          - If you experience `Locking Failed! unknown locale: UTF-8` error, then refer [pypa/pipenv#187](https://github.com/pypa/pipenv/issues/187) to solve it.
        - `python -m pipenv install --dev --system`
        - `pre-commit install`
        
        ### Run tests
        
        You can run all of tests running on CI via `tox` in your local.
        
        ```bash
        $ tox
        ```
        
        You also can run particular tests like below.
        
        #### Unit
        
        ```bash
        $ pytest test/unit
        ```
        
        Run with `pytest-xdist`
        
        ```bash
        $ pytest -n 2 test/unit
        ```
        
        #### Functional
        
        ```bash
        $ pytest test/functional/ios/search_context/find_by_ios_class_chain_tests.py
        ```
        
        #### In parallel for iOS
        
        1. Create simulators named 'iPhone X - 8100' and 'iPhone X - 8101'
        2. Install test libraries via pip, `pip install pytest pytest-xdist`
        3. Run tests
        
        ```bash
        $ pytest -n 2 test/functional/ios/search_context/find_by_ios_class_chain_tests.py
        ```
        
        ## Release
        
        Follow below steps.
        
        ```bash
        $ pip install twine
        $ pip install git+git://github.com/vaab/gitchangelog.git # Getting via GitHub repository is necessary for Python 3.7
        # Type the new version number and 'yes' if you can publish it
        # You can test the command with DRY_RUN
        $ DRY_RUN=1 ./release.sh
        $ ./release.sh # release
        ```
        
        ## License
        
        Apache License v2
        
Keywords: appium,selenium,selenium 4,python client,mobile automation
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Description-Content-Type: text/markdown
