Skip to main content

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

Project description

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

Infoworks SDK Usage GIF

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:

from infoworks.sdk.client import InfoworksClientSDK
# Your refresh token here
refresh_token = "zThziQ7MoJJPYAha+U/+PBSTZG944F+SHBDs+m/z2qn8+m/ax8Prpzla1MHzQ5EBLzB2Bw8a+Qs9r6En5BEN2DsmUVJ6sKFb2yI2"
# Initialise the client
iwx_client = InfoworksClientSDK()
iwx_client.initialize_client_with_defaults("http", "10.18.1.28", "3001", 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 (nitin.bs@infoworks.io) Abhishek Raviprasad (abhishek.raviprasad@infoworks.io)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

infoworkssdk-4.0a1.tar.gz (123.8 kB view details)

Uploaded Source

File details

Details for the file infoworkssdk-4.0a1.tar.gz.

File metadata

  • Download URL: infoworkssdk-4.0a1.tar.gz
  • Upload date:
  • Size: 123.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for infoworkssdk-4.0a1.tar.gz
Algorithm Hash digest
SHA256 3759ee351c72f2a88810b6a8443ad1e21c303fccd7103585c9f524e2beec2196
MD5 322150e962e9234a3ef851c511789f29
BLAKE2b-256 0a98b01e34be214428748920b55b065737dbdad736375187ba6bfce8450214bd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page