Skip to main content

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.

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
        })

Support

If you need any support or assistance, please contact customer-engineering@infoworks.io

Metadata

Release files for infoworkssdk 5.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for infoworkssdk 5.2.0
File Size Uploaded
infoworkssdk-5.2.0.tar.gz 157.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for infoworkssdk 5.2.0
File Interpreter ABI Platform
infoworkssdk-5.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 347.7 kB

Release files / infoworkssdk-5.2.0.tar.gz

Download URL infoworkssdk-5.2.0.tar.gz
Size 157.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a0d4ff54edfd1e7d985dbd9a0306c8acc47b5e024af995f4c84d2679c2df13d5
BLAKE2b-256 checksum
How to use checksums
2d6876bd817b1397f3b398d3134bed38af7ffd781f6c36a65da0d5c1138c7691
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.8

Release files / infoworkssdk-5.2.0-py3-none-any.whl

Download URL infoworkssdk-5.2.0-py3-none-any.whl
Size 190.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
375db139c5dabed6e0b2f7a46fbe4f2e0a5fc96083196b32198c2b33870ff849
BLAKE2b-256 checksum
How to use checksums
797396f4d21fa1fc4334c7f2c3274301b263020e2b4f4e5b6147dbe9462d3448
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.8

Release history Release notifications | RSS feed

This release

5.2.0 This release

2 release files

5.1.2

1 release file

5.1.1

1 release file

5.1.0

2 release files

5.0.9

1 release file

5.0.8

1 release file

5.0.7

1 release file

5.0.6

1 release file

5.0.5

1 release file

5.0.4

1 release file

5.0.3

1 release file

5.0.2

1 release file

5.0.1

1 release file

5.0

1 release file

4.1.1

1 release file

4.1

1 release file

4.0

1 release file

3.2

1 release file

3.1

1 release file

3.0

1 release file

2.0.8

1 release file

2.0.7

1 release file

2.0.6

1 release file

2.0.5

1 release file

2.0.4

1 release file

2.0.3

1 release file

2.0.2

1 release file

2.0.1

1 release file

1.1.0

1 release file

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page