Installation

Using ftrack connect

The ftrack connect hieroplayer review plugin is included in the built version of ftrack connect package to use it download and run ftrack connect.

Running from source

You can clone the public repository:

$ git clone git@bitbucket.org:ftrack/ftrack-connect-hieroplayer.git

Or download the zipball

Once you have a copy of the repository, copy the Python folder from the resource folder into the plugin folder for HIEROPLAYER. To find out where the plugin folder is on your system consult the The Foundry developer documentation.

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-hieroplayer/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 Python API (Download from your ftrack server and make available on PYTHONPATH)
  • HIEROPLAYER or Hiero

Additional For building

Additional For testing