openlayer.OpenlayerClient.load_project_version#

OpenlayerClient.load_project_version(version_id)#

Loads an existing project version from the Openlayer platform. Can be used to check the status of the project version and the number of passing, failing and skipped tests.

Parameters:
idstr

UUID of the project to be loaded. You can find the UUID of a project by navigating to the project’s page on the Openlayer platform.

Note

When you run push, it will return the project version object, which you can use to check your test statuses.

Returns:
project_versions.ProjectVersion

An object that is used to check for upload progress and test statuses. Also contains other useful information about a project version.

Examples

Instantiate the client and load the project version:

>>> import openlayer
>>> client = openlayer.OpenlayerClient('YOUR_API_KEY_HERE')
>>>
>>> version = client.load_project_version(id='YOUR_PROJECT_ID_HERE')
>>> version.wait_for_completion()
>>> version.print_test_report()

With the project_versions.ProjectVersion object loaded, you are able to check progress and test statuses.