infoworkssdk 4.0

A package to work with Infoworks via SDK. This library is compatible with Infoworks v5.5 onwards. Code can be found in https://github.com/Infoworks/InfoworksPythonSDK branch: release/sdk-3.0

Infoworks Python SDK

Introduction

The Infoworks Python library provides convenient access to the Infoworks v3 APIs from applications written in the Python language.

It includes pre-defined set of functions performing various actions.

Supports Infoworks version 5.3 onwards

Table of Contents

• Introduction
• Documentation
• Installation
• Usage
• Example
• Authors

Documentation

https://infoworks.github.io/infoworks-python-sdk/

Installation

You don't need this source code unless you want to modify the package. If you just want to use the package, just run:

pip install infoworkssdk

Requirements

Python 3.4+ (PyPy supported)

Usage

The library needs to be configured with your user's refresh token key which is available in your Infoworks UI. Set refresh_token to its value.

Steps to get refresh token:

https://docs.infoworks.io/infoworks-5.5.0/developer-resources/rest-api#using-refresh-token

from infoworks.sdk.client import InfoworksClientSDK
# Your refresh token here
protocol="https"
host="<your infoworks hostname>"
port="443"
refresh_token = "<your_refresh_token>"
# Initialise the client
iwx_client = InfoworksClientSDK()
iwx_client.initialize_client_with_defaults(protocol=protocol, ip=host, port=port, refresh_token=refresh_token)

Example

Create Oracle Source

src_create_response = iwx_client.create_source(source_config={
            "name": "iwx_sdk_srcname",
            "type": "rdbms",
            "sub_type": "oracle",
            "data_lake_path": "/iw/sources/iwx_sdk_srcname",
            "environment_id": "",
            "storage_id": "",
            "is_source_ingested": True
        })

Authors

Nitin B.S ([e-mail]) Abhishek Raviprasad ([e-mail])