Mobile Scripts Python OpenSDK

A collection of useful scripts for mobile setup while working with TestProject Python OpenSDK


Before using some of the below methods, we will need to obtain an API key, agent ID and device UDID which are all can be extracted from TestProject UI, no worries it really simple.

  1. Navigate to TestProject API Page:, get your API Key, or create one if you do not have one.

3. In the Agents tab, press on the desired agent, devices and copy the UDID, read more about how to do it here.

4. Copy the Agent ID which you can find on the Agents page here.

Get a list of connected mobile devices

The bellow Python script will get the agent connected devices based on agent ID. Make sure to supply the API key and Agent ID which you obtained as described before.

import requests as req
api_key = "" # Your API Key, which you get from TestProject UI
agent_id = "" # The Agent ID which you also retrieve from the TestProject UI
base = f""
def get_agent_devices():
data = {"Authorization": api_key}
res = req.get(url=f"{base}/agents/{agent_id}/devices", headers=data)
print(res.status_code, res.text)
if __name__ == '__main__':

Get agent state

The agent can be in 5 different states: Disconnected, Idle, Development, Recording, Executing. to start your CI the agent should be in Ready state. Use the below Python script for validating the agent state.

import requests as req
api_key = "" # Your API Key, which you get from TestProject UI
agent_id = "" # The Agent ID which you also retrieve from the TestProject UI
base = f""
def get_agent_state():
data = {"Authorization": api_key}
res = req.get(url=f"{base}/agents/{agent_id}/state", headers=data)
print(res.status_code, res.text)
if __name__ == '__main__':

Get installed applications

Below is the Python code to query the agent API to get the installed applications on the connected device. The response will be a JSON array of all installed applications on the device selected.

import requests as req
port = "8585" # This is the feault Agent communication port
base = f"http://localhost:{port}"
udid = "" # UDID of the device to pull the apps from
def get_list_of_installed_applications():
res = req.get(url=f"{base}/api/devices/{udid}/apps")
print(res.status_code, res.text)
if __name__ == '__main__':

Installing an APK/IPA in Runtime with OpenSDK

TestProject takes care of IPA/APK installations and deployment process out of the box when using recorded tests or when uploading the code binaries to TestProject cloud. If you prefer to use a local CI with the OpenSDK, the process to install an IPA/APK programmatically on a device in Runtime will be the same as using fluent Appium commands. The below Python script will deploy and install locally saved APK/IPA on the connected device and execute the example test script.

You can reinstall the application if the 'noReset' capability is provided with the value of 'true'.

Prerequisites: TestProject agent is installed, registered and in Ready state, the latest version of TestProject OpenSDK is installed, developer key is provided (can be obtained from the integration area as described above).

If no token is provided in the constructor of the driver, it will use the environment variable TP_DEV_TOKEN

from import By
from src.testproject.sdk.drivers import webdriver
import pytest
def driver():
device_udid = "emulator-5554" # This is the Device UDID
desired_capabilities = {
"app": "C:\\Test\\testproject-demo-app.apk",
"udid": device_udid,
"platformName": "Android", # You can change this to IOS if you are installing an IPA
"fullReset": "true",
# Replace 'token' with your developer token
driver = webdriver.Remote(token="kJCeheorpsyq8u4Z17k0JQyBck1qLIf5ZrynbI6t7Fk1", desired_capabilities=desired_capabilities)
yield driver
# This simple test will install the TestProject application inside the path above and run those simple steps.
# It will re install the app using the fullReset capability.
def test_install(driver):
textfield_name = (By.ID, "name")
textfield_password = (By.ID, "password")
button_dologin = (By.ID, "login")
username = "TestProject"
password = "12345"

You can also install an IPA for an IOS device by changing the 'platformName' to IOS.