OpenAssetIO support for OpenTimelineIO

This project adds basic asset resolution capabilities to OpenTimelineIO via the OpenAssetIO API.

This allows .otio media references to point to OpenAssetIO entity references instead of file URLs. These will be transparently resolved if the plugin's media linker is enabled.

Note: This project is currently in it's early alpha stages, more information and features coming soon!

Configuration

The media linker currently takes the following arguments, settings is optional, and should be any required settings for the chosen manager:

{
    "identifier": "<required manager identifier>"
    "settings": { ...  }
}

Eg:

linker_args = {
    "identifier": "org.openassetio.examples.manager.bal",
    "settings": {
        "library_path": "my_library.json"
    }
}

timeline = otio.adapters.read_from_string(
    otio_str,
    media_linker_name="openassetio_media_linker",
    media_linker_argument_map=linker_args
)

Setup and testing

At this stage, due to the alpha nature of this project, and OpenAssetIO itself, setup is somewhat manual.

First, clone this repository:

git clone https://github.com/TheFoundryVisionmongers/otio-openassetio
cd otio-openassetio

We recommend a local venv, but feel feel to adapt this to your needs:

python -m venv .venv
. .venv/bin/activate

This project is dependent on :

opentimelineio
openassetio
openassetio_mediacreation

These dependencies, and the plugin itself, can be installed from the project root via

pip install -e .

OpenTimelineIO plugin

The dev extras will also install the required testing dependencies.

pip install -e '.[dev]'

Testing

The tests make us of the BasicAssetLibrary example manager plugin from the OpenAssetIO repository. If BasicAssetLibrary is installed into your environment, (which it will be if you've installed the dev extras), it will be discovered automatically via importlib package discovery.

Therefore, the tests can be run from the root of the project directory, as follows:

pytest tests

Licensing