Skip to content

Commit

Permalink
[Docs] Update README.md to reflect project status
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Cowland <tom@foundry.com>
  • Loading branch information
foundrytom committed Nov 24, 2023
1 parent fea2d8b commit 9b64d38
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,26 @@

A library of OpenAssetIO extensions for use in Media Creation workflows.

> Note: This repository is currently in a pre-alpha state, and so should
> **Warning:**
> This repository is currently in a beta state, and so should
> not be used for any production critical applications.
Included are several well-known Traits and Specifications for use in
OpenAssetIO hosts and managers. For more information on this mechanism,
see the [OpenAssetIO docs](https://openassetio.github.io/OpenAssetIO).

MediaCreation is an automatically generated Python package,
Digital Content Creation tools and wth Asset Management Systems found in
the media production space. For more information on the Traits and
Specifications mechanism, see the [OpenAssetIO
docs](https://openassetio.github.io/OpenAssetIO).

The project aims to align with the [MovieLabs
Ontology](https://movielabs.com/production-technology/ontology-for-media-creation/)
project wherever possible. Presently this equates to traits and their
properties directly mapping to specific ontology sub-schemas and their
property definitions.

MediaCreation is an automatically generated Python/C++ package,
[openassetio-traitgen](https://github.com/OpenAssetIO/OpenAssetIO-TraitGen)
is used to generate trait implementations based on [traits.yml](traits.yml)
is used to generate trait implementations based on
[traits.yml](traits.yml).

## Examples

Expand All @@ -37,14 +47,17 @@ jupyter notebook

These initial incarnations of traits/specifications serve as
illustrative examples to facilitate discussion and experimentation.
Pending tasks:
Pending tasks required to reach a stable `v1.0`:

- [x] Define YAML schema to represent traits/specifications.
- [x] Auto-generate Python classes from YAML
- [x] Auto-generate CPP classes from YAML
- [ ] Auto-generate C classes from YAML.
- [ ] Extend library to cover common post-production entities and
- [x] Extend library to cover common post-production entities and
locales.
- [ ] Define how [change is managed](https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/issues/65)
within the library.
- [ ] Determine if there is a neccesary [mechanism for extending
existing Specifications](https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/issues/65).

## Installation

Expand Down Expand Up @@ -113,6 +126,8 @@ welcome!

When adding new Traits and Specifications:

0. Review the [guidelines](GUIDELINES.md)
1. Update [traits.yml](traits.yml)
2. Add an [import test](tests/python/openassetio_mediacreation/test_imports.py)
3. Update the [RELEASE_NOTES](RELEASE_NOTES.md)

0 comments on commit 9b64d38

Please sign in to comment.