Skip to content

Commit 2e45034

Browse files
committed
[Docs] Add top-level README for examples
Added as part of OpenAssetIO#1324. Add a listing of known example usages of OpenAssetIO, including the examples in the repo, and link to it from the top-level README. Signed-off-by: David Feltell <david.feltell@foundry.com>
1 parent d081370 commit 2e45034

File tree

2 files changed

+105
-6
lines changed

2 files changed

+105
-6
lines changed

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@ workflows in content creation tooling.
99

1010
> - 👋 Come chat with us on [ASWF Slack](https://academysoftwarefdn.slack.com/archives/C03Q36QS8N4)
1111
> or our [mailing list](https://lists.aswf.io/g/openassetio-discussion).
12-
> - 🧰 Get started with the API [docs](https://openassetio.github.io/OpenAssetIO),
12+
> - 🧰 Get started with the [API docs](https://openassetio.github.io/OpenAssetIO),
1313
> Manager plugin [template](https://github.com/OpenAssetIO/Template-OpenAssetIO-Manager-Python),
14-
> [OpenAssetIO-MediaCreation](https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation#readme)
14+
> and [MediaCreation](https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation#readme)
1515
> for post-production workflows.
16-
> - 📖 Or see some examples: Ayon [manager plugin](https://github.com/ynput/ayon-openassetio-manager-plugin/tree/main#readme),
17-
> USD [Asset Resolver prototype](https://github.com/OpenAssetIO/usdOpenAssetIOResolver#readme),
18-
> OTIO [media linker](https://github.com/OpenAssetIO/otio-openassetio)
16+
> - 📖 Or see some [examples](examples/README.md) in the OpenAssetIO
17+
> ecosystem.
1918
> - 👀 You can follow the development effort [here](https://github.com/orgs/OpenAssetIO/projects/1/views/7)
2019
> and the longer term roadmap [here](ROADMAP.md).
2120
@@ -239,4 +238,4 @@ During this period, one may assume that the `x` above is synonymous with
239238
major version, and the `y` with minor version, for the purpose of
240239
compatibility. This means patch versions will be rolled into minor
241240
versions, but you may still consult the [release
242-
notes](./RELEASE_NOTES.md) for specific compatibility information.
241+
notes](./RELEASE_NOTES.md) for specific compatibility information.

examples/README.md

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Examples
2+
3+
There is an ever-growing list of example OpenAssetIO hosts and manager
4+
plugins. They cover a large range, including reference implementations,
5+
testing utilities, proof of concepts, and production integrations.
6+
7+
## This repository
8+
9+
In this repository you can find simple examples of host applications
10+
and manager plugins that make use of OpenAssetIO.
11+
12+
### Hosts
13+
14+
#### simpleResolver
15+
16+
The [simpleResolver](host/simpleResolver/README.md) is a Python
17+
command-line tool that can take an entity reference and a list of
18+
trait IDs, `resolve` them, and present the results as a dictionary
19+
in the terminal.
20+
21+
### Managers
22+
23+
#### SimpleCppManager
24+
25+
The [SimpleCppManager](manager/SimpleCppManager/README.md) is a C++
26+
OpenAssetIO manager plugin that provides functionality for a limited
27+
cross-section of the OpenAssetIO API. Its "database" of entities is
28+
taken directly from the settings provided by the host. It is designed to
29+
be used for testing C++ plugin support in host applications.
30+
31+
## Other OpenAssetIO projects
32+
33+
### Python manager plugin template
34+
35+
The [Python manager plugin template](https://github.com/OpenAssetIO/Template-OpenAssetIO-Manager-Python)
36+
provides a documentation-by-example implementation of a Python manager
37+
plugin.
38+
39+
### Jupyter notebooks
40+
41+
An ever-expanding collection of [Jupyter](https://jupyter.org/)
42+
notebooks is available as
43+
[examples in the MediaCreation](https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/tree/main/examples)
44+
repository. These demonstrate core OpenAssetIO concepts alongside the
45+
wider ecosystem, in particular as it relates to the VFX and media
46+
creation industry, through executable Python snippets. The pre-rendered
47+
notebooks can be viewed directly in GitHub, so downloading to execute
48+
locally is not required.
49+
50+
### Basic Asset Library
51+
52+
The [Basic Asset Library
53+
(BAL)](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL) is a
54+
Python OpenAssetIO manager and plugin that is designed to enable host
55+
applications to test their integration against a wide spectrum of
56+
possible asset management system archetypes. It is designed to be fully
57+
puppetable, with responses controlled by a JSON configuration file. BAL
58+
is used extensively by the team for internal testing and demos of
59+
OpenAssetIO. Note that it is not intended as a reference implementation.
60+
61+
### USD Ar2 shim plugin
62+
63+
The [USD Asset Resolver plugin](https://github.com/OpenAssetIO/usdOpenAssetIOResolver#readme)
64+
allows OpenAssetIO plugins to be used within the USD ecosystem, by
65+
adapting the Ar2 API to the OpenAssetIO API.
66+
67+
### OpenTimelineIO media linker plugin
68+
69+
The [OTIO media linker](https://github.com/OpenAssetIO/otio-openassetio)
70+
plugin allows OpenAssetIO entity references to be recognised within
71+
OTIO documents, and resolved to their file path when the document is
72+
loaded.
73+
74+
## External projects
75+
76+
### Nuke
77+
78+
[Nuke](https://www.foundry.com/products/nuke-family/nuke) is the
79+
industry-leading commercial compositing tool by Foundry. As of
80+
version [15.1](https://campaigns.foundry.com/products/nuke-family/whats-new),
81+
Nuke has built-in support for OpenAssetIO as a headline feature.
82+
83+
### Ayon manager plugin
84+
85+
[Ayon by Ynput](https://ynput.io/ayon/) is an open source asset
86+
management system that forms part of Ynput's pipeline-as-service
87+
offering. Their
88+
[manager plugin](https://github.com/ynput/ayon-openassetio-manager-plugin)
89+
is available on GitHub.
90+
91+
### Blender OpenAssetIO demo script
92+
93+
[Blender](https://www.blender.org/) is an open source 3D digital content
94+
creation tool.
95+
96+
The [Blender relationships demo script](https://github.com/elliotcmorris/openassetio-relationships-blender)
97+
adds UI elements to Blender that allow a user to load external geometry
98+
from an asset management system, and pick alternative proxy
99+
representations of that geometry by querying OpenAssetIO entity
100+
relationships.

0 commit comments

Comments
 (0)