Installing

Installation is simple with pip:

pip install ftrack-python-api

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 zipball or cloning the public repository:

git clone git@bitbucket.org:ftrack/ftrack-python-api.git

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

python setup.py install

Alternatively, just build locally and manage yourself:

python setup.py build

Building documentation from source

To build the documentation from source:

python setup.py build_sphinx

Then view in your browser:

file:///path/to/ftrack-python-api/build/doc/html/index.html

Running tests against the source

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

python setup.py test

Dependencies

• ftrack server >= 3.3.11
• Python >=2.7.9, <4.0
• Requests >= 2, <3
• Arrow >= 0.4.4, < 1
• termcolor >= 1.1.0, < 2
• pyparsing >= 2.0, < 3
• Clique >= 1.2.0, < 2
• websocket-client >= 0.40.0, < 1

Additional For building

• Sphinx >= 1.2.2, < 1.6
• sphinx_rtd_theme >= 0.1.6, < 1
• Lowdown >= 0.1.0, < 2

Additional For testing

• Pytest >= 2.7, < 3
• pytest-mock >= 0.4, < 1,
• pytest-catchlog >= 1, <=2