ibm-watsonx-data-integration 0.0.1b0__tar.gz

ibm_watsonx_data_integration-0.0.1b0/LICENSE

@@ -0,0 +1,190 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 IBM Corp.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ibm_watsonx_data_integration-0.0.1b0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: ibm-watsonx-data-integration
+Version: 0.0.1b0
+Summary: A Python SDK for watsonx.data integration.
+Author: IBM
+License: Apache-2.0
+Project-URL: Documentation, https://ibm.github.io/ibm-watsonx-data-integration-sdk/
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: inflection~=0.5.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: pydantic~=2.10.6
+Requires-Dist: jsondiff>=2.2.1
+Dynamic: license-file
+
+Welcome to ibm-watsonx-data-integration
+
+`ibm-watsonx-data-integration` is a Python SDK that enables developers and data engineers to programmatically interact with the watsonx.data integration service, IBM's next-generation data integration platform built to support modern, hybrid-cloud data pipelines.
+With this SDK, users can automate and manage Flow lifecycles such as creating, configuring, starting, stopping, and monitoring Flows directly in code.
+
+Package documentation
+=====================
+
+Full documentation is available at:
+`https://ibm.github.io/ibm-watsonx-data-integration-sdk <https://ibm.github.io/ibm-watsonx-data-integration-sdk>`_

ibm_watsonx_data_integration-0.0.1b0/README.rst

@@ -0,0 +1,10 @@
+Welcome to ibm-watsonx-data-integration
+
+`ibm-watsonx-data-integration` is a Python SDK that enables developers and data engineers to programmatically interact with the watsonx.data integration service, IBM's next-generation data integration platform built to support modern, hybrid-cloud data pipelines.
+With this SDK, users can automate and manage Flow lifecycles such as creating, configuring, starting, stopping, and monitoring Flows directly in code.
+
+Package documentation
+=====================
+
+Full documentation is available at:
+`https://ibm.github.io/ibm-watsonx-data-integration-sdk <https://ibm.github.io/ibm-watsonx-data-integration-sdk>`_

ibm_watsonx_data_integration-0.0.1b0/ibm_watsonx_data_integration/__init__.py

@@ -0,0 +1,10 @@
+# IBM Confidential
+# PID 5900-BAF
+# Copyright StreamSets Inc., an IBM Company 2025
+
+"""This package contains API Clients, models and abstractions for WatsonX Data Integration Services."""
+
+from ibm_watsonx_data_integration.__version__ import __version__  # noqa: F401
+from ibm_watsonx_data_integration.platform import Platform
+
+__all__ = ["Platform"]

ibm_watsonx_data_integration-0.0.1b0/ibm_watsonx_data_integration/__version__.py

@@ -0,0 +1,7 @@
+#  IBM Confidential
+#  PID 5900-BAF
+#  Copyright StreamSets Inc., an IBM Company 2025
+
+"""This module is used to set the version of the package."""
+
+__version__ = "0.0.1b"

ibm_watsonx_data_integration-0.0.1b0/ibm_watsonx_data_integration/common/__init__.py

@@ -0,0 +1,5 @@
+# IBM Confidential
+# PID 5900-BAF
+# Copyright StreamSets Inc., an IBM Company 2025
+
+"""Common modules used across this SDK."""

ibm_watsonx_data_integration-0.0.1b0/ibm_watsonx_data_integration/common/auth.py

@@ -0,0 +1,114 @@
+# IBM Confidential
+# PID 5900-BAF
+# Copyright StreamSets Inc., an IBM Company 2025
+
+"""Authentication module."""
+
+import logging
+import requests
+import time
+from abc import ABC, abstractmethod
+from urllib.parse import urlparse, urlunparse
+
+logger = logging.getLogger(__name__)
+
+
+class BaseAuthenticator(ABC):
+    """Base Authenticator classes to be inherited by other authenticators."""
+
+    @abstractmethod
+    def get_authorization_header(self) -> str:
+        """Returns the token formatted to be plugged into the Authorization header of a request.
+
+        Returns:
+            A :py:obj:`str` ready to be used as an Authorization header.
+        """
+        pass
+
+
+class IAMAuthenticator(BaseAuthenticator):
+    """Authenticator class to authenticate using an IBM Cloud IBM API Key.
+
+    Attributes:
+        api_key: API key being used to authenticate.
+        token_url: URL being used to authenticate against.
+        iam_token: The token generated using the api_key and url.
+        token_expiry_time: UNIX time in seconds for when the token will expire.
+    """
+
+    # give a time buffer for expiration, to have ample time to make a request without the token being expired.
+    EXPIRATION_TIME_BUFFER = 5
+
+    def __init__(self, api_key: str, base_auth_url: str = "https://cloud.ibm.com") -> None:
+        """Initializes IAM Authenticator.
+
+        Args:
+            api_key: The API key to be used for authentication.
+            base_auth_url: The base URL of the IBM cloud instance to be used for authentication.
+
+        Raises:
+            TypeError: If api_key or base_auth_url are not of type str.
+            ValueError: If api_key or base_auth_url are an empty str or if base_auth_url is not a valid url.
+            requests.exceptions.HTTPError: If there is an error getting a valid token.
+        """
+        if not isinstance(api_key, str):
+            raise TypeError("api_key should be of type str.")
+        if not api_key:
+            raise ValueError("api_key should not be an empty str.")
+
+        if not isinstance(base_auth_url, str):
+            raise TypeError("base_auth_url should be of type str.")
+        if not base_auth_url:
+            raise ValueError("base_auth_url should not be an empty str.")
+
+        self.api_key = api_key
+
+        # base_auth_url looks like: "https://cloud.ibm.com"
+        # token url looks like: "https://iam.cloud.ibm.com/identity/token"
+        parsed_url = urlparse(url=base_auth_url)
+        new_netloc = "iam." + parsed_url.netloc
+        new_path = parsed_url.path + "/identity/token"
+        self.token_url = urlunparse((parsed_url.scheme, new_netloc, new_path, "", "", ""))
+
+        self.iam_token = None
+        self.token_expiry_time = None
+        self.request_token()
+
+    def request_token(self) -> None:
+        """Request a token from the servers using the API key.
+
+        Raises:
+            requests.exceptions.HTTPError: If there is an error getting a valid token.
+        """
+        headers = {"Content-Type": "application/x-www-form-urlencoded"}
+        data = {"apikey": self.api_key, "grant_type": "urn:ibm:params:oauth:grant-type:apikey"}
+
+        response = requests.post(self.token_url, headers=headers, data=data)
+        response.raise_for_status()
+
+        self.iam_token = response.json()["access_token"]
+        self.token_expiry_time = response.json()["expiration"]
+
+    def get_token(self) -> str:
+        """Get existing token, or request a new one if the current token is expired.
+
+        Returns:
+            A :py:obj:`str` containing the current token.
+        """
+        current_time = int(time.time())
+        if self.iam_token is None:
+            logger.debug("Getting first token.")
+            self.request_token()
+        elif (current_time + self.EXPIRATION_TIME_BUFFER) >= self.token_expiry_time:
+            logger.debug("Previous token expired, refreshing.")
+            self.request_token()
+
+        return self.iam_token
+
+    def get_authorization_header(self) -> str:
+        """Returns the token formatted to be plugged into the Authorization header of a request.
+
+        Returns:
+            A :py:obj:`str` ready to be used as an Authorization header.
+        """
+        return f"Bearer {self.get_token()}"

ibm_watsonx_data_integration-0.0.1b0/ibm_watsonx_data_integration/common/constants.py

@@ -0,0 +1,34 @@
+# IBM Confidential
+# PID 5900-BAF
+# Copyright StreamSets Inc., an IBM Company 2025
+
+"""This module contains project-wide constants."""
+
+from enum import Enum
+
+DATASTAGE = "datastage"
+
+RESOURCE_PLAN_ID_MAP = {DATASTAGE: "aaa6e83e-27df-4393-9a55-63feec09c685"}
+DEFAULT_RESOURCE_REGION_ID_MAP = {DATASTAGE: "us-south"}
+
+# BASE MODEL VARS
+HIDDEN_DICTIONARY = "_hidden_key_paths"
+EXPOSE_SUB_CLASS = "_expose"
+
+# PROD URLS
+GLOBAL_CATALOG_URL = "https://globalcatalog.cloud.ibm.com/api"
+RESOURCE_CONTROLLER_URL = "https://resource-controller.cloud.ibm.com"
+PROD_BASE_URL = "https://api.dataplatform.cloud.ibm.com"
+ACCOUNT_MANAGEMENT_URL = "https://accounts.cloud.ibm.com"
+USER_MANAGEMENT_URL = "https://user-management.cloud.ibm.com"
+IAM_URL = "https://iam.cloud.ibm.com"
+
+
+class DataActions(str, Enum):
+    """Actions supported in EXPOSED_DATH_PATH."""
+
+    IGNORE = "IGNORE"
+    EXPOSE = "EXPOSE"  # Shouldn't be used on the base level
+
+
+SUPPORTED_FLOWS = {"streamsets"}

ibm_watsonx_data_integration-0.0.1b0/ibm_watsonx_data_integration/common/json_patch_format.py

@@ -0,0 +1,214 @@
+#  IBM Confidential
+#  PID 5900-BAF
+#  Copyright StreamSets Inc., an IBM Company 2025
+
+"""This module defines a utility function to create JSON Patch format payloads.
+
+Implementation is limited to the following use cases:
+    1. Changing property values.
+    2. Removing entries from a collection list.
+    3. Adding entries to a collection list.
+"""
+
+import json
+import jsondiff
+from abc import ABC, abstractmethod
+from collections.abc import MutableMapping
+
+
+def prepare_json_patch_payload(origin: dict, updated: dict, exclude_properties: list[str] | None = None) -> str:
+    """Entrypoint function for creating a JSON Patch format-compliant payload.
+
+    Args:
+        origin: Dictionary with original data before changes.
+        updated: Dictionary after applying changes and updates.
+        exclude_properties: List of flatten keys for properties to not include in payload.
+
+    Returns:
+        A JSON string compliant with the JSON Patch format standard.
+    """
+    difference = jsondiff.diff(origin, updated, syntax="explicit")
+    flatten = flatten_jsondiff_explicit_result(difference)
+    return create_json_patch_document(flatten, exclude_properties=exclude_properties)
+
+
+def flatten_jsondiff_explicit_result(
+    dictionary: MutableMapping, parent_key: str = "", separator: str = "/", last_operation: str = ""
+) -> dict:
+    """Flattens key paths from the result of ``jsondiff.diff``.
+
+    This function is tightly coupled with the 3rd party library ``jsondiff``.
+    It will work correctly for results returned by the ``explicit`` flag for the ``syntax`` argument.
+
+    Args:
+        dictionary: A result from ``jsondiff.diff`` execution.
+        parent_key: Parent key from the perspective of the current processing key.
+        separator: Character that will be used to delimit keys.
+        last_operation: Operations mean keys starting with the ``$`` character.
+            This parameter holds the last one in the current traversable path.
+
+    Returns:
+        A dictionary with flattened paths as keys and the original values as values.
+    """
+    items = []
+
+    for key, value in dictionary.items():
+        if str(key).startswith("$"):
+            last_operation = key
+            new_key = f"{parent_key}" if parent_key else ""
+        else:
+            new_key = f"{parent_key}{separator}{key}" if parent_key else key
+
+        if isinstance(value, MutableMapping):
+            items.extend(
+                flatten_jsondiff_explicit_result(
+                    value, new_key, separator=separator, last_operation=last_operation
+                ).items()
+            )
+        else:
+            items.append((f"{last_operation}{separator}{new_key}", value))
+    return dict(items)
+
+
+def create_json_patch_document(flatten_dict: dict, exclude_properties: list[str] | None = None) -> str:
+    """Creates JSON document compliant with JSON Path format standard.
+
+    Args:
+        flatten_dict: Dictionary with flatted keys to values returned by ``flatten_jsondiff_explicit_result``.
+        exclude_properties: List of flatten key paths for properties to exclude from patch document.
+
+    Returns:
+        A string representing JSON Path format document.
+    """
+    if exclude_properties is None:
+        exclude_properties = list()
+
+    exclude_properties_lower = list(map(lambda s: s.lower(), exclude_properties))
+    operations = []
+
+    for k, v in flatten_dict.items():
+        path = k[k.find("/") :]
+
+        if path.lower() in exclude_properties_lower:
+            continue
+
+        operation = map_operations(k[: k.find("/")], path, v)
+        operations.extend(operation.value)
+
+    return json.dumps(sorted(operations, key=operation_weight_sort_key))
+
+
+class Operation(ABC):
+    """Represent single operation acceptable by JSON Patch Format."""
+
+    def __init__(self, path: str, raw_data: list | dict | object) -> None:
+        """Initialize Operation class with private attributes.
+
+        Args:
+            path: Flatten key path.
+            raw_data: Value for given key, format defined by ``json.diff``.
+        """
+        self._path = path
+        self._raw_data = raw_data
+
+    @property
+    @abstractmethod
+    def value(self) -> list[dict]:
+        """Returns list with JSON Path format operation objects."""
+        raise NotImplementedError
+
+
+class AddOperation(Operation):
+    """Creates operations for adding objects."""
+
+    @property
+    def value(self) -> list[dict]:
+        """Returns list with JSON Path format operation objects."""
+        result = []
+        if isinstance(self._raw_data, list):
+            for add_object in self._raw_data:
+                index = add_object[0]
+                value = add_object[1]
+                result.append({"op": "add", "path": f"{self._path}/{index}", "value": value})
+        else:
+            result.append(
+                {
+                    "op": "add",
+                    "path": self._path,
+                    "value": self._raw_data,
+                }
+            )
+        return result
+
+
+class RemoveOperation(Operation):
+    """Creates operations for removing objects."""
+
+    @property
+    def value(self) -> list[dict]:
+        """Returns list with JSON Path format operation objects."""
+        result = []
+        if isinstance(self._raw_data, list):
+            for index in self._raw_data:
+                result.append({"op": "remove", "path": f"{self._path}/{index}"})
+        else:
+            result.append(
+                {
+                    "op": "remove",
+                    "path": self._path,
+                }
+            )
+        return result
+
+
+class ReplaceOperation(Operation):
+    """Creates operations for replacing objects."""
+
+    @property
+    def value(self) -> list[dict]:
+        """Returns list with JSON Path format operation objects."""
+        result = [{"op": "replace", "path": self._path, "value": self._raw_data}]
+        return result
+
+
+def map_operations(op_name: str, path: str, raw_data: dict | list | object) -> Operation:
+    """Maps an operation from the ``jsondiff`` library to  corresponding in the JSON Path format specification.
+
+    Args:
+        op_name: Operation name used in ``jsondiff`` library, prefixed with ``$``.
+        path: Flatten key path.
+        raw_data: Operation related information created by ``jsondiff`` library.
+
+    Returns:
+        An Operation object that performs the creation of the appropriate operation object.
+
+    Raises:
+        ValueError: If an undefined operation is provided.
+    """
+    op_name_lower = op_name.lower()
+
+    if op_name_lower == "$update":
+        return ReplaceOperation(path, raw_data)
+    elif op_name_lower == "$insert":
+        return AddOperation(path, raw_data)
+    elif op_name_lower == "$delete":
+        return RemoveOperation(path, raw_data)
+    else:
+        raise ValueError("Undefined operation!")
+
+
+def operation_weight_sort_key(operation: dict) -> int:
+    """Controls the order of operation execution.
+
+    Args:
+        operation: A JSON Path format operation dictionary.
+
+    Returns:
+        A weight for the given operation, which will be used when sorting.
+    """
+    op_weight_map = {
+        "remove": 1,
+        "add": 2,
+        "replace": 3,
+    }
+    return op_weight_map[operation["op"]]