Skip to content

Latest commit

 

History

History
100 lines (72 loc) · 3.72 KB

README.md

File metadata and controls

100 lines (72 loc) · 3.72 KB

Examples

There is an ever-growing list of example OpenAssetIO hosts and manager plugins. They cover a large range, including reference implementations, testing utilities, proof of concepts, and production integrations.

This repository

In this repository you can find simple examples of host applications and manager plugins that make use of OpenAssetIO.

Hosts

simpleResolver

The simpleResolver is a Python command-line tool that can take an entity reference and a list of trait IDs, resolve them, and present the results as a dictionary in the terminal.

Managers

SimpleCppManager

The SimpleCppManager is a C++ OpenAssetIO manager plugin that provides functionality for a limited cross-section of the OpenAssetIO API. Its "database" of entities is taken directly from the settings provided by the host. It is designed to be used for testing C++ plugin support in host applications.

Other OpenAssetIO projects

Python manager plugin template

The Python manager plugin template provides a documentation-by-example implementation of a Python manager plugin.

Jupyter notebooks

An ever-expanding collection of Jupyter notebooks is available as examples in the MediaCreation repository. These demonstrate core OpenAssetIO concepts alongside the wider ecosystem, in particular as it relates to the VFX and media creation industry, through executable Python snippets. The pre-rendered notebooks can be viewed directly in GitHub, so downloading to execute locally is not required.

Basic Asset Library

The Basic Asset Library (BAL) is a Python OpenAssetIO manager and plugin that is designed to enable host applications to test their integration against a wide spectrum of possible asset management system archetypes. It is designed to be fully puppetable, with responses controlled by a JSON configuration file. BAL is used extensively by the team for internal testing and demos of OpenAssetIO. Note that it is not intended as a reference implementation.

USD Ar2 shim plugin

The USD Asset Resolver plugin allows OpenAssetIO plugins to be used within the USD ecosystem, by adapting the Ar2 API to the OpenAssetIO API.

OpenTimelineIO media linker plugin

The OTIO media linker plugin allows OpenAssetIO entity references to be recognised within OTIO documents, and resolved to their file path when the document is loaded.

External projects

Nuke

Nuke is the industry-leading commercial compositing tool by Foundry. As of version 15.1, Nuke has built-in support for OpenAssetIO as a headline feature.

Ayon manager plugin

Ayon by Ynput is an open source asset management system that forms part of Ynput's pipeline-as-service offering. Their manager plugin is available on GitHub.

Blender OpenAssetIO demo script

Blender is an open source 3D digital content creation tool.

The Blender relationships demo script adds UI elements to Blender that allow a user to load external geometry from an asset management system, and pick alternative proxy representations of that geometry by querying OpenAssetIO entity relationships.