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
Then you can build and install the package against your current Python
The result plugin will then be available under the build folder. Copy or symlink the result plugin folder in your FTRACK_CONNECT_PLUGIN_PATH.
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¶
- Sphinx >= 1.2.2, < 2
- sphinx_rtd_theme >= 0.1.6, < 1