From 3a5d58cdd24216e22a96ef2487402d8ffd54dcbd Mon Sep 17 00:00:00 2001 From: apetrynet Date: Fri, 26 Sep 2025 20:07:36 +0200 Subject: [PATCH 1/4] removed the remaining opentimelineio_contrib statements and documentation Signed-off-by: apetrynet --- CMakeLists.txt | 1 - docs/tutorials/otio-serialized-schema.md | 42 ++++++++++++------------ docs/tutorials/write-an-adapter.md | 3 +- setup.cfg | 9 +++-- 4 files changed, 27 insertions(+), 28 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index e53f335c7b..0fb070512c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -31,7 +31,6 @@ option(OTIO_PYTHON_INSTALL "Install the Python bindings" OFF) option(OTIO_DEPENDENCIES_INSTALL "Install OTIO's C++ header dependencies (Imath)" ON) option(OTIO_INSTALL_PYTHON_MODULES "Install OTIO pure Python modules/files" ON) option(OTIO_INSTALL_COMMANDLINE_TOOLS "Install the OTIO command line tools" ON) -option(OTIO_INSTALL_CONTRIB "Install the opentimelineio_contrib Python package" ON) option(OTIO_FIND_IMATH "Find Imath using find_package" OFF) option(OTIO_FIND_RAPIDJSON "Find RapidJSON using find_package" OFF) set(OTIO_PYTHON_INSTALL_DIR "" CACHE STRING "Python installation dir (such as the site-packages dir)") diff --git a/docs/tutorials/otio-serialized-schema.md b/docs/tutorials/otio-serialized-schema.md index 1b9dcd0b87..9c07c31f77 100644 --- a/docs/tutorials/otio-serialized-schema.md +++ b/docs/tutorials/otio-serialized-schema.md @@ -29,24 +29,24 @@ changes. If it needs to be updated and this file regenerated, run: ``` Adapters convert between OTIO and other formats. - Note that this class is not subclassed by adapters. Rather, an adapter is - a python module that implements at least one of the following functions: +Note that this class is not subclassed by adapters. Rather, an adapter is +a python module that implements at least one of the following functions: - .. code-block:: python +.. code-block:: python - write_to_string(input_otio) - write_to_file(input_otio, filepath) (optionally inferred) - read_from_string(input_str) - read_from_file(filepath) (optionally inferred) + write_to_string(input_otio) + write_to_file(input_otio, filepath) (optionally inferred) + read_from_string(input_str) + read_from_file(filepath) (optionally inferred) - ...as well as a small json file that advertises the features of the adapter - to OTIO. This class serves as the wrapper around these modules internal - to OTIO. You should not need to extend this class to create new adapters - for OTIO. +...as well as a small json file that advertises the features of the adapter +to OTIO. This class serves as the wrapper around these modules internal +to OTIO. You should not need to extend this class to create new adapters +for OTIO. - For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- +For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- adapter.html. # noqa - + ``` parameters: @@ -261,14 +261,14 @@ parameters: ``` Defines an OTIO plugin Manifest. - This is considered an internal OTIO implementation detail. +This is considered an internal OTIO implementation detail. - A manifest tracks a collection of plugins and enables finding them by name - or other features (in the case of adapters, what file suffixes they - advertise support for). +A manifest tracks a collection of plugins and enables finding them by name +or other features (in the case of adapters, what file suffixes they +advertise support for). + +For more information, consult the documentation. - For more information, consult the documentation. - ``` parameters: @@ -287,8 +287,8 @@ parameters: ``` A class of plugin that is encoded in a python module, exposed via a - manifest. - +manifest. + ``` parameters: diff --git a/docs/tutorials/write-an-adapter.md b/docs/tutorials/write-an-adapter.md index bae913e031..b37675ad9d 100644 --- a/docs/tutorials/write-an-adapter.md +++ b/docs/tutorials/write-an-adapter.md @@ -240,4 +240,5 @@ def export_timeline(timeline): ## Examples -OTIO includes a number of "core" (supported by the core team) adapters in `opentimelineio/adapters` as well as a number of community supported adapters in `opentimelineio_contrib/adapters`. +OTIO includes "core" adapters for `.otio`, `.otiod` and `otioz` files found in in `opentimelineio/adapters`. +In addition to these you'll find many more adapters in the various repositories under the [OpenTimelineIO Organization](https://github.com/OpenTimelineIO) diff --git a/setup.cfg b/setup.cfg index 88fec56b37..7844591680 100644 --- a/setup.cfg +++ b/setup.cfg @@ -8,7 +8,7 @@ description_file = README.md # flake8 ############################################################################### [flake8] -exclude = +exclude = .tox *.egg build @@ -48,20 +48,19 @@ ignore-bad-ideas = ############################################################################### [coverage:run] branch = True -source = +source = opentimelineio - opentimelineio_contrib ./tests [coverage:paths] -otio = +otio = src/py-opentimelineio/opentimelineio *site-packages/opentimelineio [coverage:report] include =* # Regexes for lines to exclude from consideration -omit = +omit = *aaf2* *pkg_resources* *pbr* From aafa7de67e829c49d19ce7131c7c095e2657c8f5 Mon Sep 17 00:00:00 2001 From: apetrynet Date: Mon, 29 Sep 2025 21:57:11 +0200 Subject: [PATCH 2/4] attempting to please ci with spaces in the right places Signed-off-by: apetrynet --- docs/tutorials/otio-serialized-schema.md | 38 ++++++++++++------------ 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/tutorials/otio-serialized-schema.md b/docs/tutorials/otio-serialized-schema.md index 9c07c31f77..b6ed123678 100644 --- a/docs/tutorials/otio-serialized-schema.md +++ b/docs/tutorials/otio-serialized-schema.md @@ -29,24 +29,24 @@ changes. If it needs to be updated and this file regenerated, run: ``` Adapters convert between OTIO and other formats. -Note that this class is not subclassed by adapters. Rather, an adapter is -a python module that implements at least one of the following functions: + Note that this class is not subclassed by adapters. Rather, an adapter is + a python module that implements at least one of the following functions: -.. code-block:: python + .. code-block:: python - write_to_string(input_otio) - write_to_file(input_otio, filepath) (optionally inferred) - read_from_string(input_str) - read_from_file(filepath) (optionally inferred) + write_to_string(input_otio) + write_to_file(input_otio, filepath) (optionally inferred) + read_from_string(input_str) + read_from_file(filepath) (optionally inferred) -...as well as a small json file that advertises the features of the adapter -to OTIO. This class serves as the wrapper around these modules internal -to OTIO. You should not need to extend this class to create new adapters -for OTIO. + ...as well as a small json file that advertises the features of the adapter + to OTIO. This class serves as the wrapper around these modules internal + to OTIO. You should not need to extend this class to create new adapters + for OTIO. -For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- + For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- adapter.html. # noqa - + ``` parameters: @@ -261,11 +261,11 @@ parameters: ``` Defines an OTIO plugin Manifest. -This is considered an internal OTIO implementation detail. + This is considered an internal OTIO implementation detail. -A manifest tracks a collection of plugins and enables finding them by name -or other features (in the case of adapters, what file suffixes they -advertise support for). + A manifest tracks a collection of plugins and enables finding them by name + or other features (in the case of adapters, what file suffixes they + advertise support for). For more information, consult the documentation. @@ -287,8 +287,8 @@ parameters: ``` A class of plugin that is encoded in a python module, exposed via a -manifest. - + manifest. + ``` parameters: From 490c2f1701e41a4a4d09eab7f391cbb40124ff8b Mon Sep 17 00:00:00 2001 From: apetrynet Date: Mon, 29 Sep 2025 22:03:21 +0200 Subject: [PATCH 3/4] make doc-model-update as suggested by tests Signed-off-by: apetrynet --- docs/tutorials/otio-serialized-schema.md | 38 ++++++++++++------------ 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/tutorials/otio-serialized-schema.md b/docs/tutorials/otio-serialized-schema.md index b6ed123678..9c07c31f77 100644 --- a/docs/tutorials/otio-serialized-schema.md +++ b/docs/tutorials/otio-serialized-schema.md @@ -29,24 +29,24 @@ changes. If it needs to be updated and this file regenerated, run: ``` Adapters convert between OTIO and other formats. - Note that this class is not subclassed by adapters. Rather, an adapter is - a python module that implements at least one of the following functions: +Note that this class is not subclassed by adapters. Rather, an adapter is +a python module that implements at least one of the following functions: - .. code-block:: python +.. code-block:: python - write_to_string(input_otio) - write_to_file(input_otio, filepath) (optionally inferred) - read_from_string(input_str) - read_from_file(filepath) (optionally inferred) + write_to_string(input_otio) + write_to_file(input_otio, filepath) (optionally inferred) + read_from_string(input_str) + read_from_file(filepath) (optionally inferred) - ...as well as a small json file that advertises the features of the adapter - to OTIO. This class serves as the wrapper around these modules internal - to OTIO. You should not need to extend this class to create new adapters - for OTIO. +...as well as a small json file that advertises the features of the adapter +to OTIO. This class serves as the wrapper around these modules internal +to OTIO. You should not need to extend this class to create new adapters +for OTIO. - For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- +For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- adapter.html. # noqa - + ``` parameters: @@ -261,11 +261,11 @@ parameters: ``` Defines an OTIO plugin Manifest. - This is considered an internal OTIO implementation detail. +This is considered an internal OTIO implementation detail. - A manifest tracks a collection of plugins and enables finding them by name - or other features (in the case of adapters, what file suffixes they - advertise support for). +A manifest tracks a collection of plugins and enables finding them by name +or other features (in the case of adapters, what file suffixes they +advertise support for). For more information, consult the documentation. @@ -287,8 +287,8 @@ parameters: ``` A class of plugin that is encoded in a python module, exposed via a - manifest. - +manifest. + ``` parameters: From 12fe74dd5d2de299708af5c288a84f8800416762 Mon Sep 17 00:00:00 2001 From: apetrynet Date: Mon, 29 Sep 2025 22:56:58 +0200 Subject: [PATCH 4/4] built with older python and ran make doc-model-update again as suggested by test Signed-off-by: apetrynet --- docs/tutorials/otio-serialized-schema.md | 42 ++++++++++++------------ 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/tutorials/otio-serialized-schema.md b/docs/tutorials/otio-serialized-schema.md index 9c07c31f77..1b9dcd0b87 100644 --- a/docs/tutorials/otio-serialized-schema.md +++ b/docs/tutorials/otio-serialized-schema.md @@ -29,24 +29,24 @@ changes. If it needs to be updated and this file regenerated, run: ``` Adapters convert between OTIO and other formats. -Note that this class is not subclassed by adapters. Rather, an adapter is -a python module that implements at least one of the following functions: + Note that this class is not subclassed by adapters. Rather, an adapter is + a python module that implements at least one of the following functions: -.. code-block:: python + .. code-block:: python - write_to_string(input_otio) - write_to_file(input_otio, filepath) (optionally inferred) - read_from_string(input_str) - read_from_file(filepath) (optionally inferred) + write_to_string(input_otio) + write_to_file(input_otio, filepath) (optionally inferred) + read_from_string(input_str) + read_from_file(filepath) (optionally inferred) -...as well as a small json file that advertises the features of the adapter -to OTIO. This class serves as the wrapper around these modules internal -to OTIO. You should not need to extend this class to create new adapters -for OTIO. + ...as well as a small json file that advertises the features of the adapter + to OTIO. This class serves as the wrapper around these modules internal + to OTIO. You should not need to extend this class to create new adapters + for OTIO. -For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- + For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an- adapter.html. # noqa - + ``` parameters: @@ -261,14 +261,14 @@ parameters: ``` Defines an OTIO plugin Manifest. -This is considered an internal OTIO implementation detail. + This is considered an internal OTIO implementation detail. -A manifest tracks a collection of plugins and enables finding them by name -or other features (in the case of adapters, what file suffixes they -advertise support for). - -For more information, consult the documentation. + A manifest tracks a collection of plugins and enables finding them by name + or other features (in the case of adapters, what file suffixes they + advertise support for). + For more information, consult the documentation. + ``` parameters: @@ -287,8 +287,8 @@ parameters: ``` A class of plugin that is encoded in a python module, exposed via a -manifest. - + manifest. + ``` parameters: