Datatamer / tamr-client

Programmatically interact with Tamr
https://tamr-client.readthedocs.io
Apache License 2.0
11 stars 25 forks source link

Expand custom client docs to cover DMS usage #495

Closed olivito closed 2 years ago

olivito commented 3 years ago

🙋 feature request

Expand the docs section on "Custom Host / Port / Base API path" to cover the options required to use DMS. https://tamr-client.readthedocs.io/en/stable/user-guide/advanced-usage.html#custom-host-port-base-api-path

💁 Possible Solution

Here is a working example to create a client for calling DMS:

dms_client = Client(host="10.10.0.1", port=9155, auth=(username, password), base_path="/")

This differs from the default example in that it uses auth=(username, password) instead of auth=UsernamePasswordAuth(username, password), and it sets the base path.

🔦 Context

Since DMS is part of Tamr's supported product, we should have an example of how to call its APIs via python.