Corrections

Author: agarneha1331

README.md

@@ -74,7 +74,7 @@ Ensure that @ symbol is prepended to the file path in the above request. Please
 
 Open `Android` or `iOS` folder :
 
-- If you have uploaded your own app, update the app in the `browserstack.yml`
+- If you have uploaded your own app, update the app id or directly upload the path to your app in the `browserstack.yml` 
 
 - Run `browserstack-sdk python browserstack_sample.py`
 
@@ -102,9 +102,9 @@ Ensure that @ symbol is prepended to the file path in the above request. Please
 
 Open `Android` or `iOS` folder :
 
-- Ensure that `local` capability is set to `true` in the `browserstack.yml` file
+- Ensure that `browserstackLocal` capability is set to `true` in the `browserstack.yml` file
 
-- If you have uploaded your own app, update the app in the `browserstack.yml`
+- If you have uploaded your own app, update the app capability with the app id or directly upload the path to your app in the `browserstack.yml` 
 
 - Run `browserstack-sdk python browserstack_sample_local.py`
 

android/browserstack.yml

@@ -23,6 +23,8 @@ buildIdentifier: '#${BUILD_NUMBER}' # Supports strings along with either/both ${
 
 source: 'python:appium-sample-sdk:v1.0'
 
+# Set `app` to define the app that is to be used for testing. 
+# It can either take the id of any uploaded app or the path of the app directly.
 app: ./WikipediaSample.apk
 # app: ./LocalSample.apk #For running local tests
 
@@ -52,7 +54,7 @@ platforms:
 # Example 1 - If you have configured 3 platforms and set `parallelsPerPlatform` as 2, a total of 6 (2 * 3) parallel threads will be used on BrowserStack
 #
 # Example 2 - If you have configured 1 platform and set `parallelsPerPlatform` as 5, a total of 5 (1 * 5) parallel threads will be used on BrowserStack
-# parallelsPerPlatform: 1
+parallelsPerPlatform: 1
 
 # ==========================================
 # BrowserStack Local

android/browserstack_sample.py

@@ -5,8 +5,29 @@
 from selenium.webdriver.support import expected_conditions as EC
 import time
 
+options = UiAutomator2Options().load_capabilities({
+    # Specify device and os_version for testing
+    "platformName" : "android",
+    "platformVersion" : "9.0",
+    "deviceName" : "Google Pixel 3",
+
+    # Set URL of the application under test
+    "app" : "bs://<app-id>",
+
+    # Set other BrowserStack capabilities
+    'bstack:options' : {
+        "projectName" : "BrowserStack Samples",
+        "buildName" : "browserstack build",
+        "sessionName" : "BStack sample python-appium",
+
+        # Set your access credentials
+        "userName" : "YOUR_USERNAME",
+        "accessKey" : "YOUR_ACCESS_KEY"
+    }
+})
+
 # Initialize the remote Webdriver using BrowserStack remote URL
-driver = webdriver.Remote("http://hub.browserstack.com/wd/hub")
+driver = webdriver.Remote("http://localhost:4444/wd/hub", options=options)
 
 # Test case for the BrowserStack sample Android app.
 # If you have uploaded your app, update the test case here.

android/browserstack_sample_local.py

@@ -3,11 +3,35 @@
 from appium.webdriver.common.appiumby import AppiumBy
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.support import expected_conditions as EC
-from browserstack.local import Local
 import time
 
+# 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
+options = UiAutomator2Options().load_capabilities({
+    # Set URL of the application under test
+    "app" : "bs://<app-id>",
+
+    # Specify device and os_version for testing
+    "deviceName": "Google Pixel 3",
+    "platformName": "android",
+    "platformVersion": "9.0",
+
+    # Set other BrowserStack capabilities
+    "bstack:options": {
+        "projectName" : "BrowserStack Samples",
+        "buildName" : "browserstack build",
+        "sessionName" : "BStack local python-appium",
+        "local" : "true",
+
+        # Set your access credentials
+        "userName" : "YOUR_USERNAME",
+        "accessKey" : "YOUR_ACCESS_KEY"
+    }
+})
+
 # Initialize the remote Webdriver using BrowserStack remote URL
-driver = webdriver.Remote("http://hub.browserstack.com/wd/hub")
+driver = webdriver.Remote("http://localhost:4444/wd/hub", options=options)
 
 # Test case for the BrowserStack sample Android app. 
 # If you have uploaded your app, update the test case here. 

ios/browserstack.yml

@@ -23,8 +23,10 @@ buildIdentifier: '#${BUILD_NUMBER}' # Supports strings along with either/both ${
 
 source: 'python:appium-sample-sdk:v1.0'
 
-# app: ./BStackSampleApp.ipa
-app: ./LocalSample.ipa #For running local tests
+# Set `app` to define the app that is to be used for testing. 
+# It can either take the id of any uploaded app or the path of the app directly.
+app: ./BStackSampleApp.ipa
+# app: ./LocalSample.ipa #For running local tests
 
 # =======================================
 # Platforms (Browsers / Devices to test)

ios/browserstack_sample.py

@@ -5,8 +5,32 @@
 from selenium.webdriver.support import expected_conditions as EC
 import time
 
+# 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
+options = XCUITestOptions().load_capabilities({
+    # Set URL of the application under test
+    "app" : "bs://<app-id>",
+
+    # Specify device and os_version for testing
+    "deviceName": "iPhone 11 Pro",
+    "platformName": "ios",
+    "platformVersion": "13",
+
+    # Set other BrowserStack capabilities
+    "bstack:options": {
+        "projectName" : "BrowserStack Samples",
+        "buildName" : "browserstack build",
+        "sessionName" : "BStack sample python-appium",
+
+        # Set your access credentials
+        "userName" : "YOUR_USERNAME",
+        "accessKey" : "YOUR_ACCESS_KEY"
+    }
+})
+
 # Initialize the remote Webdriver using BrowserStack remote URL
-driver = webdriver.Remote("http://hub.browserstack.com/wd/hub")
+driver = webdriver.Remote("http://localhost:4444/wd/hub", options=options)
 
 # Test case for the BrowserStack sample iOS app.
 # If you have uploaded your app, update the test case here. 

ios/browserstack_sample_local.py

@@ -3,11 +3,35 @@
 from appium.webdriver.common.appiumby import AppiumBy
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.support import expected_conditions as EC
-from browserstack.local import Local
 import os
 
+# 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
+options = XCUITestOptions().load_capabilities({
+    # Set URL of the application under test
+    "app" : "bs://<app-id>",
+
+    # Specify device and os_version for testing
+    "deviceName": "iPhone XS",
+    "platformName": "ios",
+    "platformVersion": "12",
+
+    # Set other BrowserStack capabilities
+    "bstack:options": {
+        "projectName" : "BrowserStack Samples",
+        "buildName" : "browserstack build",
+        "sessionName" : "BStack local python-appium",
+        "local" : "true",
+
+        # Set your access credentials
+        "userName" : "YOUR_USERNAME",
+        "accessKey" : "YOUR_ACCESS_KEY"
+    }
+})
+
 # Initialize the remote Webdriver using BrowserStack remote URL
-driver = webdriver.Remote("http://hub.browserstack.com/wd/hub")
+driver = webdriver.Remote("http://localhost:4444/wd/hub", options=options)
 
 # Test case for the BrowserStack sample iOS app. 
 # If you have uploaded your app, update the test case here. 

requirements.txt

@@ -1,3 +1,2 @@
 Appium-Python-Client==2.6.1;python_version >= '3.0'
-browserstack-local==1.2.2
-browserstack-sdk==1.4.0
+browserstack-sdk