ibm-dfo-sdk 0.0.11

IBM Data Fabric Orchestrator python SDK

IBM Data Fabric Orchestrator python SDK

Python client library to interact with various IBM Data Fabric Orchestrator Services APIs.

Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.

Table of Contents

• IBM Data Fabric Orchestrator python SDK
  • Table of Contents
  • Overview
  • Prerequisites
  • Installation
  • Using the SDK
  • Questions
  • Issues
  • Open source @ IBM
  • Contributing
  • License

Overview

The IBM Data Fabric Orchestrator Services Python SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name	Module Name	Imported Class Name
Data Fabric Orchestrator Service	ibm_dfo_sdk	ibm_data_fabric_orchestrator_v1

Prerequisites

• Access to an IBM Data Fabric Orchestrator service.
• Python 3.8 or above.

Installation

To install, use pip:

pip install --upgrade ibm-dfo-sdk

Then in your code, you can import the appropriate service like this:

from ibm-dfo-sdk.ibm_data_fabric_orchestrator_v1 import *

Using the SDK

Examples and a demo are available in the examples folder. The basic_use_of_get_service.py example is probably the easiest to get started with. Other examples cover more specific cases and detailed APIs.

Note that while this SDK is intended for use with the IBM Data Fabric Orchestrator on IBM Cloud CPDaaS or on-prem CPD instances with the IBM Data Fabric Orchestrator add-on installed, it can also be used when IBM Data Fabric Orchestrator add-on not installed. So the sdk user should always use the high-level get_service() function create a DFO service, which will automatically adapt to these senarios. After get the service instance from get_service() function, can use or configure the service instance as your needs.

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.md.

License

This SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.