Updated directory structure, readme, and added parallel testing sample code

.gitignore

@@ -0,0 +1,3 @@
+*/local.log
+*/browserstack.err
+*/**.pyc

README.md

@@ -1,13 +1,108 @@
 # python-appium-app-browserstack
-App Automate Python Samples
----------------------
 
-This repository contains code for Automated Native App tests. Please feel free to clone the repo and use the example code.
-Refer [Getting Started with App Automate](https://www.browserstack.com/app-automate/appium-python) for more details.
+This repository demonstrates how to run Appium tests using Python on BrowserStack App Automate.
+
+## Setup
+
+### Requirements
+
+1. Python 3.6+ or Python 2.7+
+
+    - If Python is not installed, follow these instructions:
+        - For Windows, download latest python version from [here](https://www.python.org/downloads/windows/) and run the installer executable
+        - For Mac and Linux, run `python --version` to see what python version is pre-installed. If you want a different version download from [here](https://www.python.org/downloads/)
+
+2. Package Manager `pip`
+
+    Note : `pip` comes installed with Python 2.7.9+ and python 3.4+
+
+    - If `pip` is not installed, follow these instructions:
+        - Securely download get-pip.py by following this link: [get-pip.py](https://bootstrap.pypa.io/get-pip.py) or use following cURL command to download it:
+
+        ```sh
+        curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
+        ```
+
+        - After dowloading, run the file :
+
+            - For Python 3
+
+                ```sh
+                python3 get-pip.py
+                ```
+
+            - For Python 2
+
+                ```sh
+                python2 get-pip.py
+                ```
+
+### Install the dependencies
+
+To install the dependencies for Android tests, run :
+
+- For Python 3
+
+    ```sh
+    pip3 install -r android/requirements.txt
+    ```
+
+- For Python 2
+
+    ```sh
+    pip2 install -r android/requirements.txt
+    ```
+
+Or,
+
+To install the dependencies for iOS tests, run :
+
+- For Python 3
+
+    ```sh
+    pip3 install -r ios/requirements.txt
+    ```
+
+- For Python 2
+
+    ```sh
+    pip2 install -r ios/requirements.txt
+    ```
+
+
+## Getting Started
+
+Getting Started with Appium tests in Python on real BrowserStack devices couldn't be easier!
+
+### **Run first test :**
+
+- Switch to `run-first-test` directory under [Android examples](android/examples/run-first-test) or [iOS examples](ios/examples/run-first-test)
+
+- Follow the steps outlined in the documentation [Getting Started with your first test on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/python)
+
+### **Speed up test execution with parallel testing :**
+
+- Switch to `run-prarallel-tests` directory under [Android examples](android/examples/run-parallel-tests) or [iOS examples](ios/examples/run-parallel-tests)
+
+- Follow the steps outlined in the documentation [Getting Started with Parallel testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/python/parallelize-tests)
+
+### **Use Local testing for apps that access resources hosted in development or testing environments :**
+
+- Switch to `run-local-test` directory under [Android examples](android/examples/run-local-test) or [iOS examples](ios/examples/run-local-test)
+
+- Follow the steps outlined in the documentation [Getting Started with Local testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/python/local-testing)
+
+**Note**: If you face any issues, refer [Getting Help section](#Getting-Help)
+
+## Integration with other python frameworks
+
+For other Python frameworks samples, refer to following repositories :
 
-For frameworks integration with BrowserStack, refer to their individual repositories -
-- [Lettuce](https://github.com/browserstack/lettuce-appium-app-browserstack)
 - [Behave](https://github.com/browserstack/behave-appium-app-browserstack)
+- [Lettuce](https://github.com/browserstack/lettuce-appium-app-browserstack)
+
+Note: For other test frameworks supported by App-Automate refer our [Developer documentation](https://www.browserstack.com/docs/)
+
+## Getting Help
 
-For python 2 support refer the branch
-- [python-2-master](https://github.com/browserstack/python-appium-app-browserstack/tree/python-2-master)
+If you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help).

android/examples/run-first-test/config.json

@@ -0,0 +1,13 @@
+{
+    "username":"BROWSERSTACK_USERNAME",
+    "access_key":"BROWSERSTACK_ACCESS_KEY",
+
+    "capabilities": {
+        "project": "First Python Android Project",
+        "build": "Python Android",
+        "name": "first_test",
+        "browserstack.debug": true,
+        "app": "bs://<hashed app-id>",
+        "device": "Google Pixel"
+    }
+}

android/examples/run-first-test/first_test.py

@@ -0,0 +1,51 @@
+from appium import webdriver
+from appium.webdriver.common.mobileby import MobileBy
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+import time
+import os, json
+
+config_file_path = os.path.join(os.path.dirname(__file__), "config.json")
+print("Config file path = %s" % (config_file_path))
+with open(config_file_path) as config_file:
+    CONFIG = json.load(config_file)
+
+BROWSERSTACK_USERNAME = os.environ['BROWSERSTACK_USERNAME'] if 'BROWSERSTACK_USERNAME' in os.environ else CONFIG['username']
+BROWSERSTACK_ACCESS_KEY = os.environ['BROWSERSTACK_ACCESS_KEY'] if 'BROWSERSTACK_ACCESS_KEY' in os.environ else CONFIG['access_key']
+
+def test():
+    """
+     Test for BrowserStack sample Wikipedia Android app.
+     Note: If you have uploaded your app to BrowserStack update the test here.
+    """
+
+    desired_capabilities = CONFIG['capabilities']
+
+    driver = webdriver.Remote(
+    desired_capabilities = desired_capabilities,
+    command_executor = "http://%s:%[email protected]/wd/hub" % (BROWSERSTACK_USERNAME, BROWSERSTACK_ACCESS_KEY)
+    )
+
+    search_element = WebDriverWait(driver, 30).until (
+    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Search Wikipedia"))
+    )
+
+    search_element.click()
+
+    search_input = WebDriverWait(driver, 30).until (
+    EC.element_to_be_clickable((MobileBy.ID, "org.wikipedia.alpha:id/search_src_text"))
+    )
+
+    search_input.send_keys("BrowserStack")
+
+    time.sleep(5)
+
+    search_results = driver.find_elements_by_class_name("android.widget.TextView")
+
+    assert(len(search_results) > 0)
+
+    driver.quit()
+
+
+if __name__ == "__main__":
+    test()

android/examples/run-local-test/config.json

@@ -0,0 +1,14 @@
+{
+    "username":"BROWSERSTACK_USERNAME",
+    "access_key":"BROWSERSTACK_ACCESS_KEY",
+
+    "capabilities": {
+        "project": "First Python Android Project",
+        "build": "Python Android Local",
+        "name": "local_test",
+        "browserstack.debug": true,
+        "app": "bs://<hashed app-id>",
+        "device": "Samsung Galaxy S7",
+        "browserstack.local": true
+    }
+}