Installing

Pre-built packages are available for download for Windows, Linux and Mac from the Integrations webpage.

The pre-built packages includes integrations for various applications:

  • 3DS Max
  • Hiero
  • Maya
  • Nuke
  • Nuke Studio
  • RV

Note

Alternative installation methods require technical knowledge.

Building from git repository

Alternatively, install using pip:

pip install git+https://bitbucket.org/ftrack/ftrack-connect.git

Note

This project is not yet available on PyPi.

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-connect.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-connect/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

There are also interactive tests for many of the widgets that can be run directly once you have configured your environment to include the built package:

python test/interactive/timer.py

Dependencies

  • Python >= 2.6, < 3

  • PySide >= 1.2.2, < 2

    Note

    On Windows, PySide does not always put the required pyside-rcc runtime in an accessible place. If you encounter build errors when installing, try adding the location of pyside-rcc to your PATH:

    $ set "PATH=C:\Python27\Lib\site-packages\PySide\;%PATH%"
    
  • Riffle >= 0.1.0, < 2

  • ftrack Python API (Download from your ftrack server and make available on PYTHONPATH)

Additional For building

Additional For testing