Tutorial: Get Tamr version¶
This tutorial will cover basic Python client usage by guiding you through:
Configuring the connection to a Tamr instance
Retrieving the version of that instance
Prerequisites¶
To complete this tutorial you will need:
tamr-unify-client
installedaccess to a Tamr instance, specifically:
a username and password that allow you to log in to Tamr
the socket address of the instance
The socket address is composed of
The protocol, such as
"https"
or"http"
The host, which may be
"localhost"
if the instance is deployed from the same machine from which your Python code will be runThe port at which you access the Tamr user interface, typically
9100
When you view the Tamr user interface in a browser, the url is <protocol>://<host>:<port>
. If the port is missing, the URL is simply <protocol>://host
.
Steps¶
The Session¶
The Tamr Python client uses a Session
to persist the user’s authentication details across requests made to the server where Tamr is hosted.
A Session
carries authentication credentials derived from a username and password, and is not explicitly tied to any single Tamr instance. For more details, see the documentation for the Requests library.
Use your username and password to create an instance of
tamr_client.UsernamePasswordAuth
.Use the function
tamr_client.session.from.auth
to create aSession
.
from getpass import getpass
import tamr_client as tc
username = input("Tamr Username:")
password = getpass("Tamr Password:")
auth = tc.UsernamePasswordAuth(username, password)
session = tc.session.from_auth(auth)
The Instance¶
An Instance
models the installation or instance of Tamr with which a user interacts via the Python client.
Create an
Instance
using theprotocol
,host
, andport
of your Tamr instance.
protocol = "http"
host = "localhost"
port = 9100
instance = tc.Instance(protocol=protocol, host=host, port=port)
Getting the version of Tamr¶
With the Session
and Instance
defined, you can now interact with the API of the Tamr instance. One simple example is fetching the version of the Tamr software running on the server.
Use the function
tc.instance.version
and print the returned value.
print(tc.instance.version(session, instance))
All of the above steps can be combined into the following script get_tamr_version.py
:
from getpass import getpass
import tamr_client as tc
username = input("Tamr Username:")
password = getpass("Tamr Password:")
auth = tc.UsernamePasswordAuth(username, password)
session = tc.session.from_auth(auth)
protocol = "http"
host = "localhost"
port = 9100
instance = tc.Instance(protocol=protocol, host=host, port=port)
print(tc.instance.version(session, instance))
To run the script via command line:
TAMR_CLIENT_BETA=1 python get_tamr_version.py
If successful, the printed result should be similar to v2020.016.0
.
Congratulations! This is just the start of what can be done with the Tamr Python client.
To continue learning, see other tutorials and examples.