Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.3 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.3 KB
Raw

ftrack OpenAssetIO Plugin

A skeleton OpenAssetIO ManagerPlugin that binds ftrack to the API

Warning This plugin is highly experimental, and subject to significant change.

Getting started

To use the plugin in an OpenAssetIO host, set (or append) the OPENASSETIO_PLUGIN_PATH env var to include the plugin directory in this checkout.

It requires the ftrack-python-api package to be installed.

python -m pip install -r requirements.txt

The plugin also requires openassetio to be available to python at runtime. This is normally provided by the host tool or application (see the project documentation for more information if you need to install yourself).

The plugin provides a manager with the identifier com.ftrack.

Testing

The test fixtures take care of configuring the OpenAssetIO plugin search paths for you. Assuming your working directory is set to the root of this checkout:

python -m venv .venv
. .venv/bin/activate
python -m pip install -r tests/requirements.txt

The tests currently rely on the FTRACK_* env vars to determine which server to use:

export FTRACK_SERVER=https://<yourorg>.ftrackapp.com
export FTRACK_API_KEY=<a valid key>
export FTRACK_API_USER=<a valid user>
pytest