Metadata-Version: 2.1
Name: Appium-Python-Client
Version: 2.0.0b1
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 [Selenium 3.0 draft](https://dvcs.w3.org/hg/webdriver/raw-file/tip/webdriver-spec.html) and [Mobile JSON Wire Protocol Specification draft](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md)
        functionality to the Python language bindings, for use with the mobile testing
        framework [Appium](https://appium.io).
        
        ## Notice
        
        Since **v1.0.0**, only Python 3 is supported
        
        ### developing version
        [selenium-4](https://github.com/appium/python-client/tree/selenium-4) branch is a developing branch to switch base selenium client version from v3 to v4. The branch is available as pre-release versioning like `2.0.0.a0` via pypi.
        
        Main differences since current v1 is the v2 can connect to invalid SSL environment like self-certificated server. Please take a look at the branch's README for more details.
        
        Please install lower version of `trio` like `pip install trio==0.17.0` if your environment failed to install `trio` dependency.
        
        ## 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 Selenium 3.0 specification
        draft, with some helpers to make mobile testing in Python easier. The majority of
        the usage remains as it has been for Selenium 2 (WebDriver), and as the [official
        Selenium Python bindings](https://pypi.org/project/selenium/) begins to
        implement the new specification that implementation will be used underneath, so
        test code can be written that is utilizable with both bindings.
        
        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
        import unittest
        from appium import webdriver
        
        desired_caps = dict(
            platformName='Android',
            platformVersion='10',
            automationName='uiautomator2',
            deviceName='Android Emulator',
            app=PATH('../../../apps/selendroid-test-app.apk')
        )
        self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
        el = self.driver.find_element_by_accessibility_id('item')
        el.click()
        ```
        
        ```python
        # iOS environment
        import unittest
        from appium import webdriver
        
        desired_caps = dict(
            platformName='iOS',
            platformVersion='13.4',
            automationName='xcuitest',
            deviceName='iPhone Simulator',
            app=PATH('../../apps/UICatalog.app.zip')
        )
        
        self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
        el = self.driver.find_element_by_accessibility_id('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
        import unittest
        from appium import webdriver
        
        desired_caps = dict(
            platformName='iOS',
            platformVersion='13.4',
            automationName='xcuitest',
            deviceName='iPhone Simulator',
            app=PATH('../../apps/UICatalog.app.zip')
        )
        
        self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps, direct_connection=True)
        ```
        
        ## Relax SSL validation
        
        `strict_ssl` option allows you to send commands to an invalid certificate host like self-certificated SSL.
        
        ```python
        import unittest
        from appium import webdriver
        
        desired_caps = dict(
            platformName='iOS',
            platformVersion='13.4',
            automationName='xcuitest',
            deviceName='iPhone Simulator',
            app=PATH('../../apps/UICatalog.app.zip')
        )
        
        self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps, strict_ssl=False)
        ```
        
        ## Documentation
        
        https://appium.github.io/python-client-sphinx/ is detailed documentation
        
        ## 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 8 - 8100' and 'iPhone 8 - 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 3,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: 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
