1
1
# OpenAssetIO-MediaCreation
2
2
3
3
A library of OpenAssetIO extensions for use in Media Creation workflows.
4
+ Covering images, three-dimenstional models, versioning, proxy
5
+ relationships and more.
4
6
5
- > Note: This repository is currently in a pre-alpha state, and so should
6
- > not be used for any production critical applications.
7
+ > ** Warning:**
8
+ > This repository is currently in a beta state, and so should
9
+ > be used in production critical applications with caution.
7
10
8
11
Included are several well-known Traits and Specifications for use in
9
- OpenAssetIO hosts and managers. For more information on this mechanism,
10
- see the [ OpenAssetIO docs] ( https://openassetio.github.io/OpenAssetIO ) .
12
+ Digital Content Creation tools and wth Asset Management Systems found in
13
+ the media production space. For more information on the Traits and
14
+ Specifications mechanism, see the [ OpenAssetIO
15
+ docs] ( https://openassetio.github.io/OpenAssetIO ) .
11
16
12
- MediaCreation is an automatically generated Python package,
17
+ The project attempts to align with relevant industry standards wherever
18
+ possible or appicable, incuding:
19
+
20
+ - The [ MovieLabs Ontology] ( https://movielabs.com/production-technology/ontology-for-media-creation/ ) .
21
+ - The [ OpenUSD data model] ( https://www.openusd.org ) .
22
+
23
+ MediaCreation is an automatically generated Python/C++ package,
13
24
[ openassetio-traitgen] ( https://github.com/OpenAssetIO/OpenAssetIO-TraitGen )
14
- is used to generate trait implementations based on [ traits.yml] ( traits.yml )
25
+ is used to generate trait implementations based on
26
+ [ traits.yml] ( traits.yml ) .
15
27
16
28
## Examples
17
29
@@ -37,14 +49,17 @@ jupyter notebook
37
49
38
50
These initial incarnations of traits/specifications serve as
39
51
illustrative examples to facilitate discussion and experimentation.
40
- Pending tasks:
52
+ Pending tasks required to reach a stable ` v1.0 ` :
41
53
42
54
- [x] Define YAML schema to represent traits/specifications.
43
55
- [x] Auto-generate Python classes from YAML
44
56
- [x] Auto-generate CPP classes from YAML
45
- - [ ] Auto-generate C classes from YAML.
46
- - [ ] Extend library to cover common post-production entities and
57
+ - [x] Extend library to cover common post-production entities and
47
58
locales.
59
+ - [ ] Define how [ change is managed] ( https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/issues/65 )
60
+ within the library.
61
+ - [ ] Determine if there is a neccesary [ mechanism for extending
62
+ existing Specifications] ( https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/issues/65 ) .
48
63
49
64
## Installation
50
65
@@ -113,6 +128,7 @@ welcome!
113
128
114
129
When adding new Traits and Specifications:
115
130
131
+ 0 . Review the [ guidelines] ( GUIDELINES.md )
116
132
1 . Update [ traits.yml] ( traits.yml )
117
133
2 . Add an [ import test] ( tests/python/openassetio_mediacreation/test_imports.py )
118
134
3 . Update the [ RELEASE_NOTES] ( RELEASE_NOTES.md )
0 commit comments