The Python SDK
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
tox.ini Python SDK

This SDK allows you to query and create new projects, builds or images within the VisWiz service.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

For more information, please visit


Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+

(you may need to run pip with root permission: sudo pip install git+

Then import the package:

import viswiz_sdk


Install via Setuptools.

python install --user

(or sudo python install to install the package for all users)

Then import the package:

import viswiz_sdk

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import viswiz_sdk
from import ApiException
from pprint import pprint

# Configure API key authorization: api_key
viswiz_sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
viswiz_sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = viswiz_sdk.ProjectsApi()

    api_response = api_instance.get_projects()
except ApiException as e:
    print("Exception when calling ProjectsApi->get_projects: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
AccountApi create_webhook POST /webhooks Create a new webhook
AccountApi get_account GET /account Get account info
AccountApi get_webhooks GET /webhooks Get all webhooks
BuildsApi create_build POST /projects/{projectID}/builds Create a build
BuildsApi finish_build POST /builds/{buildID}/finish Finish a build
BuildsApi get_build_results GET /builds/{buildID}/results Get results for a build
BuildsApi get_builds GET /projects/{projectID}/builds Get builds for a project
ImagesApi create_image POST /builds/{buildID}/images Create an image
ImagesApi get_images GET /builds/{buildID}/images Get images for a build
PlansApi cancel_plan DELETE /account/cancel-plan Cancel the active plan
PlansApi get_plans GET /plans Get all plans
ProjectsApi create_project POST /projects Create a project
ProjectsApi get_project_notifications GET /projects/{projectID}/notifications Get notifications settings
ProjectsApi get_projects GET /projects Get all projects
ProjectsApi update_project_notifications PUT /projects/{projectID}/notifications Update notifications settings

Documentation For Models

Documentation For Authorization


  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header