GithubHelp home page GithubHelp logo

openassetio / otio-openassetio Goto Github PK

View Code? Open in Web Editor NEW
9.0 5.0 2.0 49 KB

A prototype OpenTimelineIO plugin to allow assetized EDLs to be resolved through OpenAssetIO.

License: Apache License 2.0

Python 100.00%
openassetio opentimelineio otio

otio-openassetio's Introduction

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

This project is licensed under the Apache License, Version 2.0.

otio-openassetio's People

Contributors

elliotcmorris avatar feltech avatar foundrytom avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

otio-openassetio's Issues

Update `conan` version

Tests are currently failing as conan version is pinned to an older version that isn't supported. Just unpin for now, as it'll go away with #13

Update OTIO to use new `TraitsData` API

What

Update to use the new API as per OpenAssetIO/OpenAssetIO#348.

Why

The current code is incompatible with releases later than v1.0.0-alpha.1.

Note

See https://github.com/OpenAssetIO/OpenAssetIO/blob/75b61fdbe6565f0dfac3a9bd6d618b38dfcfcfcb/resources/examples/host/simpleResolver/simpleResolver.py#L160 (and other uses within that host) as an example.

This will also require OpenAssetIO/OpenAssetIO-MediaCreation#10 to be done, which might mean it's just worth waiting for OpenAssetIO/OpenAssetIO-MediaCreation#11.

ACs

  • Code outwardly works as per the existing version consuming openassetio v1.0.0a6 or later

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.