ftrack-connect-hieroplayer¶
ftrack connect review plugin for The Foundry’s HIEROPLAYER.
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
Using¶
For guide on how to use the plugin see internal reviews documentation.
Glossary¶
- ftrack connect
Integration of ftrack with other systems and the desktop. Provided by a core service that runs on each individuals machine and then separate integration plugins into a variety of third-party software.
See also
ftrack connect
- ftrack connect package
- ftrack connect package is a pre-built bundle of ftrack connect and the most commonly used ftrack connect plugins.
- HIEROPLAYER
- HIEROPLAYER is a desktop review tool by TheFoundry that lets you playback every shot on the VFX timeline and compare versions of renders quickly. See website for more information
- The Foundry
- The Foundry Visionmongers is a visual effects software development company. See website for more information
Release and migration notes¶
Find out information about what has changed between versions and any important migration notes to be aware of when switching to a new version.
Release notes¶
1.3.1¶
21 January 20201.3.0¶
20 December 2018- changed
InternalConvert code to standalone ftrack-connect plugin.
1.2.1¶
11 October 2018- fix
HookVersion check breaks due to changes in application version sorting with connect >= 1.5.0.
1.2.0¶
12 September 2017- fix
APINuke 11 not supported.
1.1.5¶
7 July 2017- changed
APIThe integration now uses the new API to resolve file paths and can be used to review components only accessible from the new API. Legacy locations are still supported through the location compatibility plugin in ftrack Connect.
0.1.5¶
7 June 2016- fix
HookHiero Player doesn’t get discovered in versions >9.0.
- fix
APIHiero Player is not lading correctly in versions >9.0.
0.1.4¶
9 September 2015- fix
HookAdded support for variant instead of version number in label.
0.1.3¶
17 April 2015- fix
CentosHookAdded support for launching plugin on Centos.
0.1.2¶
30 January 2015- fix
Added alternative installation directory to search path when detecting installed HieroPlayer versions.
0.1.1¶
23 January 2015- changed
Required ftrack server version is 3.0.5 or higher.
- new
Automatically sign in to ftrack when launching HIEROPLAYER.
0.1.0¶
16 January 2015- new
Initial release of the ftrack connect plugin for HIEROPLAYER.
Indices and tables¶
Copyright and license¶
Copyright (c) 2015 ftrack
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE.txt file, or at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.