Skip to content

Latest commit

 

History

History
242 lines (162 loc) · 4.86 KB

README.md

File metadata and controls

242 lines (162 loc) · 4.86 KB
Raw

PyPI version

testingbotclient

Python client for TestingBot REST API

Install

pip install testingbotclient

TestingBot

TestingBot allows you to run Selenium tests in the cloud. With access to over +2600 different browser/device combinations, you can run your browser and mobile tests in parallel on the TestingBot Grid.

Getting Started

import testingbotclient

tb = testingbotclient.TestingBotClient('key', 'secret')

It is also possible to use TESTINGBOT_KEY and TESTINGBOT_SECRET environment variables instead of specifying these in the TestingBotClient constructor. Or use a ~/.testingbot file with key:secret.

All API methods can throw these exceptions:

TestingBotException(errorMessage)

getBrowsers

Retrieves collection of available browsers https://testingbot.com/support/api

testingbotclient.information.get_browsers()

getDevices

Retrieves collection of devices https://testingbot.com/support/api#devices

testingbotclient.information.get_devices()

getAvailableDevices

Retrieves collection of devices currently available https://testingbot.com/support/api#available-devices

testingbotclient.information.get_available_devices()

getDevice

Retrieves information for a specific device https://testingbot.com/support/api#devicedetails

testingbotclient.information.get_device(deviceId)

updateTest

Update meta-data for a test https://testingbot.com/support/api#updatetest

  • String status_message
  • boolean success
  • String build
  • String name
testingbotclient.tests.update_test(sessionId, status_message=.., passed=1|0, build=.., name=..)

stopTest

Stops a running test https://testingbot.com/support/api#stoptest

testingbotclient.tests.stop_test(sessionId)

deleteTest

Deletes a test from TestingBot https://testingbot.com/support/api#deletetest

testingbotclient.tests.delete_test(sessionId)

getTest

Retrieves information regarding a test https://testingbot.com/support/api#singletest

testingbotclient.tests.get_test(sessionId)

getTests

Retrieves a collection of tests https://testingbot.com/support/api#tests

testingbotclient.tests.get_tests(offset=0, limit=30)

getBuilds

Retrieves a collection of builds https://testingbot.com/support/api#builds

testingbotclient.build.get_builds(offset=0, limit=30)

getTestsForBuild

Retrieves a collection of tests for a specific build https://testingbot.com/support/api#singlebuild

testingbotclient.build.get_tests_for_build(buildId)

deleteBuild

Deletes a specific build https://testingbot.com/support/api#deletebuild

testingbotclient.build.delete_build(buildId)

getUserConfig

Retrieves information about the current user https://testingbot.com/support/api#user

testingbotclient.user.get_user_information()

updateUser

Updates information about the current user https://testingbot.com/support/api#useredit

testingbotclient.user.update_user_information(userInformation)

getTunnels

Retrieves tunnels for the current user https://testingbot.com/support/api#apitunnellist

testingbotclient.tunnel.get_tunnels()

deleteTunnel

Deletes/stops a specific tunnel for the current user https://testingbot.com/support/api#apitunneldelete

testingbotclient.tunnel.delete_tunnel(tunnelId)

uploadToStorage - Local File

Uploads a local file to TestingBot Storage https://testingbot.com/support/api#upload

testingbotclient.storage.upload_local_file(localFilePath)

uploadToStorage - Remote File

Uploads a remote file to TestingBot Storage https://testingbot.com/support/api#upload

testingbotclient.storage.upload_remote_file(localFilePath)

getStoredFile

Retrieves meta-data from a previously stored file https://testingbot.com/support/api#uploadfile

testingbotclient.storage.get_stored_file(appUrl)

getStoredFiles

Retrieves meta-data from previously stored files https://testingbot.com/support/api#filelist

testingbotclient.storage.get_stored_files(offset=0, limit=30)

deleteStorageFile

Deletes a file previously stored in TestingBot Storage https://testingbot.com/support/api#filedelete

testingbotclient.storage.remove_file(appUrl)

get_share_link

Calculates the authenticationHash necessary to share tests https://testingbot.com/support/other/sharing

testingbotclient.get_share_link(sessionId)

Test

python tests/test_client.py

More documentation

Check out the TestingBot REST API for more information.