Skip to main content

Install tator-py

tator-py is a python client for Tator. It uses a combination of code generated from our OpenAPI compatible REST API and hand-written utilities to enable all the functionality of the Tator web interface and more. It is hosted on PyPi, so you can easily install it:

pip install tator

Now you can test it out on a deployment using a few simple commands:

import tator
api = tator.get_api(host='', token=MY_TOKEN)

Like Tator, tator-py is open-source under the MIT license. The source is available on GitHub.


The above instructions assume a python environment is already installed. For Windows users, please follow the instructions for installing python on Windows. On Linux based operating systems python can be installed with apt install python3 or dnf install python3.

Install optional dependencies

Some utilities in tator-py use optional dependencies that will raise an error if the required modules are not installed.

Requirements for local transcoding

Local transcodes can be enabled by installing ffmpeg and mp4dump from Bento4. This includes creation of multi-view videos due to the thumbnail creation process.

Ubuntu 20.04 LTS:

sudo apt-get install ffmpeg wget unzip
sudo cp Bento4-SDK-1-6-0-632.x86_64-unknown-linux/bin/mp4dump /usr/local/bin/.
sudo chmod +x /usr/local/bin/mp4dump


1.) Download and install the executables for ffmpeg. 2.) Download and install the executables for Bento4.


It is required to install these executables in a system-level or user-level path, which is any of the folders listed in: echo %PATH%. A safe default is C:\WINDOWS\system32 (system-level install) or C:\Users\<Your User>\AppData\Local\Microsoft\WindowsApps (user-level install).

Dependencies needed for graphical utilities

python-opencv is utilized in the extractor module of tator-py.

pip install pandas opencv-python