What version of the Python Client should I use?¶
If you are starting a new project or your existing project does not yet use the Python Client, we encourage you to use the latest stable version of the Python Client.
If you are already using the Python Client, you have 3 options:
- “I like my project’s code the way it is.”
Keep using the version you are on.
- “I want some new features released in versions with the same major version that I’m currently using.”
Upgrade to the latest stable version with the same major version as what you currently use.
- “I want all new features and I’m willing to modify my code to get those features!”
Upgrade to the latest stable version even if it has a different major version from what you currently use.
Note that you do not need to reason about the Unify API version nor the the Unify version.
How does this the Python Client accomplish this?
The short answer is that the Python Client just cares about features, and will try everything it knows to implement those features correctly, independent of the API version.
We’ll illustrate with an example.
Let’s say you want to get a dataset by name in your Python code.
1. If no such feature exists, you can file a Feature Request. Note that the Python Client is limited by what the Unify API enables. So you should check if the Unify API docs to see if the feature you want is even possible.
2. If this feature already exists, you can try it out!
2.a It works! 🎉
2.b If it fails with an HTTP error, it could be for 2 reasons:
2.a.i It might be impossible to support that feature in the Python Client because your Unify API version does not have the necessary endpoints to support it.
2.a.ii Your Unify API version does support this feature with some endpoints, but the Python Client know how to correctly implement this feature for this version of the API. In this case, you should submit a Feature Request.
2.c If it fails with any other error, you should submit a Bug Report. 🐛
To see how to submit Bug Reports / Feature Requests, see 🐛 Bug Reports / 🙋 Feature Requests.
To check what endpoints your version of the Unify API supports, see docs.tamr.com/reference (be sure to select the correct version in the top left!).
How do I call custom endpoints, e.g. endpoints outside the Unify API?¶
To call a custom endpoint within the Unify API, use the
client.request() method, and
provide an endpoint described by a path relative to
base_path. For example, if
/api/versioned/v1/ (the default), and you want to get
you only need to provide
projects/1 (the relative ID provided by the project) as the endpoint,
and the Client will resolve that into
There are various APIs outside the
/api/versioned/v1/ prefix that are often useful or necessary
to call - e.g.
/api/service/health, or other un-versioned / unsupported APIs. To call a custom
endpoint outside the Unify API, use the
client.request() method, and provide an endpoint
described by an absolute path (a path starting with
/). For example, to get
/api/service/health (no matter what
base_path is), call
/api/service/health as the endpoint. The Client will ignore
base_path and send the
request directly against the absolute path provided.
For additional detail, see Custom HTTP requests and Unversioned API Access.