search

OpenAssetIO / OpenAssetIO-MediaCreation

OpenAssetIO extensions for use in the Media Creation industry.
Apache License 2.0
12 stars 10 forks source link

[Docs] Add Jupyter Notebook illustrating entityTraits #69

Closed feltech closed 6 months ago

feltech commented 1 year ago

Add a notebook illustrating the usage of entityTraits, as specified in OpenAssetIO/OpenAssetIO#31.

Add another notebook illustrating advanced usage of entityTraits in a generic resolve-and-republish workflow.

The idea in the first instance is to provoke discussion and provide a reference as the feature is further refined.

An ideal outcome is that this document continues to be iterated as the feature(s) is developed, incorporating changes in design as well as new corner cases that need defining.

Eventually this should lead to an executable specification of the feature, which also serves as example documentation.

Dependencies

The notebook has dependencies on work in other repos, in particular

foundrytom commented 1 year ago

Btw - a nice thing here is by the time the work is done and this is passing we should have some usefull specifcations from #22

feltech commented 8 months ago

Update on this rather long-running notebook(s).

It's updated to use the changes in https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/issues/90 and is working nicely.

CI still targets PyPI releases for dependencies however, so either we need to retarget it, or wait til the next release, before this PR can be merged.