Getting started

TODO: Add Description

How to Build

You must have Python 2 >=2.7.9 or Python 3 >=3.4 installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc. These dependencies are defined in the requirements.txt file that comes with the SDK. To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.

Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.

• Using command line, navigate to the directory containing the generated files (including requirements.txt) for the SDK.
• Run the command pip install -r requirements.txt. This should install all the required dependencies.

How to Use

The following section explains how to use the Predix SDK package in a new project.

1. Open Project in an IDE

Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

The project files will be displayed in the side bar as follows:

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test"

Add a python file to this project with the name "testsdk"

Name it "testsdk"

In your python file you will be required to import the generated python library using the following code lines

from predix.predix_client import PredixClient

After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.

3. Run the Test Project

To run the file within your test project, right click on your Python file inside your Test project and click on Run

How to Test

You can test the generated SDK and the server with automatically generated test cases. unittest is used as the testing framework and nose is used as the test runner. You can run the tests as follows:

1. From terminal/cmd navigate to the root directory of the SDK.
2. Invoke pip install -r test-requirements.txt
3. Invoke nosetests

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter	Description
username	TODO: add a description
password	TODO: add a description

API client can be initialized as following.

# Configuration parameters and credentials
username = 'username'
password = 'password'

client = PredixClient(username, password)

Class Reference

List of Controllers

• APIController

APIController

Get controller instance

An instance of the APIController class can be accessed from the API Client.

 client_controller = client.client

create_get_token

TODO: Add Description

def create_get_token(self,
                         content_type,
                         body)

Parameters

Parameter	Tags	Description
contentType	Required	TODO: Add a parameter description
body	Required	TODO: Add a parameter description

Example Usage

content_type = 'application/x-www-form-urlencoded'
body = 'grant_type=client_credentials'

client_controller.create_get_token(content_type, body)

create_synchronous_execution_nlp

Execute the analytic synchronously. The analytic_uri is the analytic catalog entry id followed by your Predix Platform domain name.

def create_synchronous_execution_nlp(self,
                                         content_type,
                                         predix_zone_id,
                                         body)

Parameters

Parameter	Tags	Description
contentType	Required	TODO: Add a parameter description
predixZoneId	Required	TODO: Add a parameter description
body	Required	TODO: Add a parameter description

Example Usage

content_type = 'application/json'
predix_zone_id = '{{tenant_id}}'
body_value = "{\"input_text\":\"UPS fails to come up Image:NONE-NONE-NONE\"}"
body = json.loads(body_value)

client_controller.create_synchronous_execution_nlp(content_type, predix_zone_id, body)

create_synchronous_execution_predict_resolutions

Execute the analytic synchronously. The analytic_uri is the analytic catalog entry id followed by your Predix Platform domain name.

def create_synchronous_execution_predict_resolutions(self,
                                                         content_type,
                                                         predix_zone_id,
                                                         body)

Parameters

Parameter	Tags	Description
contentType	Required	TODO: Add a parameter description
predixZoneId	Required	TODO: Add a parameter description
body	Required	TODO: Add a parameter description

Example Usage

content_type = 'application/json'
predix_zone_id = '{{tenant_id}}'
body_value = "{\"symptoms\":\"this is a test\",\"errors\":\"11011,10010\"}"
body = json.loads(body_value)

client_controller.create_synchronous_execution_predict_resolutions(content_type, predix_zone_id, body)

Back to List of Controllers