DKUtils documentation

This documentation describes the DKUtils python package. It is current as of release 2.11.6.

DKUtils serves 2 main purposes: (1) provide a client for interacting with the DataKitchen platform’s REST API (i.e. DataKitchenClient) and (2) provide utility classes and methods for interacting with tools commonly orchestrated in recipes in the DataKitchen Platform (e.g. Alteryx, JIRA, GMail, etc.). Here is the list of clients presently offered by this package including a brief description of each.

Streamsets DataCollectorClient

Client object for invoking StreamSets Data Collector REST API.

DataKitchen Client

Client object for invoking DataKitchen API calls. If the API call requires a kitchen, recipe, and/or variation, you must set those fields on the client instance prior to invoking those methods (or set them via the constructor when a class instance is created).

Python scripts in recipe variations often require interactions with the DataKitchen Platform REST API. For instance, a recipe variation may want to submit order runs, monitor them, and report their status. This client facilitates those interactions in a user friendly manner.

GMailClient

Client object for access the GMail API. The create_base64_encoded_token function can be used to initially create a set of credentials which are base64 encoded in a file that can be looded into vault. This value from vault can then be used as an environment variable in a variation. The get_object_from_environment can be used to reconstitute the credentials from the environment variable.

JiraClient

Client object for invoking JIRA Python API.

RemoteClient

Client to interact with a remote host via SSH & SCP.

VeevaNetworkClient

Create a client for accessing Veeva Network. This class should not be instantiated directly. You should use either VeevaSourceSubscriptionClient or VeevaTargetSubscriptionClient.

Indices and tables