Installation is simple with pip:

pip install ftrack-python-api


Install Poetry and pre-commit (for MacOS, this can be achieved using homebrew):

brew install Poetry poetry shell poetry install pre-commit install

Building from source

You can also build manually from the source for more control. First obtain a copy of the source by either downloading the files directly from `PyPi <`_ or cloning the public repository:

git clone

Then you can build and install the package into your current Python site-packages folder:

python install

Alternatively, just build locally and manage yourself:

python build

Building documentation from source

To build the documentation from source:

python build_sphinx

Then view in your browser:


Running tests against the source

With a copy of the source it is also possible to run the unit tests:

python test


Additional For building

Additional For testing