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 FilePathUrlConverter notebook #77

Closed feltech closed 6 months ago

feltech commented 7 months ago

Following on from OpenAssetIO/OpenAssetIO#1117 add a Jupyter Notebook illustrating the usage of FilePathUrlConverter.

This is in no way complete, and was used as part of a live demo in sprint review. It seems like useful documentation nonetheless and worth keeping in the repo.

feltech commented 7 months ago

Converted to draft pending https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/pull/76 which retargets CI to OpenAssetIO main, where the feature (currently) resides.

elliotcmorris commented 7 months ago

Presumably that's why there's that ModuleNotFound error in the notebook source?

feltech commented 6 months ago

(not sure how the process for that is gonna work for jupyter stuff yet, could you accidently commit with errors baked in and still get green checks?)

The CI would still fail if the notebook failed.

One possible issue is if you committed the notebook with errors baked in, but it passed on CI, then you could happily merge and the pre-rendered output would still show errors. Tricky to detect automatically. I think it's just a job for the reviewer.