Watson Knowledge Catalog (WKC) Bulk Guru

This repo demonstrates how the WKC API can be used to perform quick updates in bulk for some laborious tasks when done through the UI.

Prerequisites and Recommended Tools

• Cloud Pak for Data 4.0 or above
• Github Desktop https://desktop.github.com/
• Git (optional for integration with VSC) https://git-scm.com/downloads
• Python 3.8 or above https://www.python.org/downloads/
• Visual Studio Code (VSC) https://code.visualstudio.com/
• Python Extension of VSC https://code.visualstudio.com/docs/python/python-tutorial

Installation

1. Make sure the prerequisites are installed.
2. clone this github repository.
3. Install necessary dependencies:

pip install -r requirements.txt

4. Create .env file with Secrets:

cp .envExample .env

Swagger UIs and other API docs

• https://{cp4d_hostname}/v3/search/api/explorer
• https://cloud.ibm.com/apidocs/watson-data-api

Programming resources

• Beginners Guide to Python: https://wiki.python.org/moin/BeginnersGuide/NonProgrammers
• Programmers Guide to Python: https://wiki.python.org/moin/BeginnersGuide/Programmers
• Getting Stared with Pandas: https://pandas.pydata.org/docs/getting_started/index.html

Use Cases

Following are the key use cases that are covered in this repo

How do I authenticate?

• Session class
• Hostname, User, Pwd or API Key
• Headers, Token

How do I generate an API Key?

https://www.ibm.com/docs/en/SSQNUZ_4.6.x/cpd/get-started/api-keys.html

How do I search for artefacts?

• Using Global Search to demonstrate how to find artefacts in WKC

How do I perfom mass (batch) updates?

• How to export a list of all data assets along with their columns and descriptions in a specific catalog and write these into a CSV
• Now the CSV can be manipulated by a business user in that for instance a description can be added or modified
• Then the CSV can be imported and all descriptions contained therein will updated updated in the catalog