mmif-python 1.4.0__tar.gz → 1.5.0__tar.gz

{mmif_python-1.4.0 → mmif_python-1.5.0}/CHANGELOG.md

@@ -1,4 +1,22 @@
 
+## releasing 1.4.0 (2026-04-22)
+### Overview
+* This is minor level release that 1) replacing simple string enums in `mmif.vocabulary` with fully-fledged pydantic classes in `clams-vocabulary` package 2) deprecating framenum-based image extraction functions in VDH (frame numbers are no longer considered as proper timestamps)
+
+### Additions
+* presentation timestamp-based image extraction functions added to VDH (https://github.com/clamsproject/mmif-python/pull/382 )
+* `pyav` and `clams-vocabulary` as new dependencies
+
+### Changes
+* opencv-based video operations are now based on pyav (ffmpeg backend)
+* all framenum-based functions in VDH are now marked as deprecated, scheduled for removal at 2.0.0
+* `mmif.vocabulary` package is now a thin wrapper around `clams-vocabulary` package (https://github.com/clamsproject/mmif-python/pull/381 )
+* `AnnotationTypes` and `DocumentTypes` classes are no longer simple string enums, but pydantic-based validation-supported python classes 
+
+### Removal 
+* `durationTimeUnit` is no longer written to video documents' `Annotation` property. This is non-API change hence not triggering major version bump. (based on https://github.com/clamsproject/mmif/pull/240/changes/a74dc46245c21dc7a279b3f271cf3e3a2a126f3a, all time notations without explicit unit specification are considered as milliseconds)
+
+
 ## releasing 1.3.1 (2026-03-11)
 ### Overview
 
@@ -8,6 +26,7 @@ Bug-fix release to address broken `as_PIL=True` option in `extract_frames_as_ima
 
 * Fix `PIL.Image` import failure in `_check_cv_dep` by switching from `importlib.__import__` to `importlib.import_module` (https://github.com/clamsproject/mmif-python/pull/377)
 
+
 ## releasing 1.3.0 (2026-03-10)
 ### Overview
 Minor release adding a new `summarize` CLI, pydantic-based workflow descriptors, and various fixes for video document helpers and timestamp handling.
@@ -26,6 +45,7 @@ Minor release adding a new `summarize` CLI, pydantic-based workflow descriptors,
 * Documentation build migrated to "build-once, stay-forever" model via documentation hub (https://github.com/clamsproject/mmif-python/pull/344)
 
 
+
 ## releasing 1.2.1 (2025-11-28)
 ### Overview
 Updated output formats of the experimental `mmif describe` command
@@ -38,6 +58,7 @@ Updated output formats of the experimental `mmif describe` command
 > [!NOTE]
 > `mmif describe` (and the underlying `mmif.utils.workflow_helper`) is still experimental and subject to change in future releases without notice. Backward compatibility is not guaranteed.
 
+
 ## releasing 1.2.0 (2025-11-20)
 ### Overview
 This version is minor release with addition of a new cli (`describe`), lots of in-line documentation updates, and deprecation of some "getter" methods
@@ -57,6 +78,7 @@ mmif.get(some_view_id)
 * many  outdated documentation updates
 
 
+
 ## releasing 1.1.2 (2025-07-28)
 ### Overview
 Patch release with a hotfix of a bug. 
@@ -64,6 +86,7 @@ Patch release with a hotfix of a bug.
 ### Changes
 * Fixed bug with handling "list of ID" props in 1.0.x MMIF. 
 
+
 ## releasing 1.1.1 (2025-07-26)
 ### Overview
 Patch release to support installation on python 3.12 and newer (fixes https://github.com/clamsproject/mmif-python/issues/314). 
@@ -72,6 +95,7 @@ Patch release to support installation on python 3.12 and newer (fixes https://gi
 - `setup.py` is now compatible with the latest setuptools (80) .
 - [Since python 3.12 no longer ship `setuptools` as a part of standard installation](https://docs.python.org/3/whatsnew/3.12.html#ensurepip), added setuptools as a `dev` dependency.
 
+
 ## releasing 1.1.0  (2025-07-23)
 ### Overview
 This is a minor version release, but it includes several significant changes and improvements across the codebase. 
@@ -88,6 +112,7 @@ This is a minor version release, but it includes several significant changes and
 * Miscellaneous cleanup and improvements on documentation and unused code. 
 
 
+
 ## releasing 1.0.19 (2024-07-29)
 ### Overview
 Patch to fix a critical bug. 
@@ -95,6 +120,7 @@ Patch to fix a critical bug.
 ### Changes
 - bugfix when `Annotation` instance and "warnings" view both are involved, MMIF is not properly returned (#299)
 
+
 ## releasing 1.0.18 (2024-07-15)
 ### Overview
 Patch release with a bugfix. 
@@ -104,6 +130,7 @@ Patch release with a bugfix.
 ### Changes
 - fixed bug when adding custom properties to a newly generated `TextDocument` object (https://github.com/clamsproject/mmif-python/issues/290)
 
+
 ## releasing 1.0.17 (2024-06-26)
 ### Overview
 This release adds caching mechanism for annotation alignments (via `Alignment` annotation, the alignment via `targets` property is not yet supported). 
@@ -117,6 +144,7 @@ This release adds caching mechanism for annotation alignments (via `Alignment` a
 - `mmif.utils.text_document_helper.slice_text` received a major speed boost from the alignment caching. 
 
 
+
 ## releasing 1.0.16 (2024-06-14)
 ### Overview
 This release includes an _experimental_ implementation for helpers to slice `text_value` from text documents. 
@@ -125,6 +153,7 @@ This release includes an _experimental_ implementation for helpers to slice `tex
 * `mmif.utils.text_document_helper` module to address https://github.com/clamsproject/mmif-python/issues/280
 
 
+
 ## releasing 1.0.15 (2024-06-07)
 ### Overview
 Minor release to add/improve helper methods.
@@ -136,6 +165,7 @@ Minor release to add/improve helper methods.
 - `Mmif.__getitem__()` now works with short annotation IDs (https://github.com/clamsproject/mmif-python/issues/279)
 
 
+
 ## releasing 1.0.14 (2024-04-10)
 ### Overview
 This release contains small fixes and improvements. 
@@ -151,6 +181,7 @@ This release contains small fixes and improvements.
 ### Changes
 - "empty" annotation property values are correctly retrievable
 
+
 ## releasing 1.0.13 (2024-04-02)
 ### Overview
 This version includes small, but helpful improvements.
@@ -161,6 +192,7 @@ This version includes small, but helpful improvements.
 * video frame sampling can now use fractional sampling rate (in terms of frame numbers)
 
 
+
 ## releasing 1.0.12 (2024-04-01)
 ### Overview
 Hot-fixing a wrong field name. 
@@ -169,6 +201,7 @@ Hot-fixing a wrong field name.
 - `views[].metadata.app_configuration` is renamed to `appConfiguration`, correctly following the MMIF json schema. 
 
 
+
 ## releasing 1.0.11 (2024-03-31)
 ### Overview
 This release includes changes from MMIF spec 1.0.3 and 1.0.4, and a new helper module to handle sequence annotations
@@ -186,6 +219,7 @@ This release includes changes from MMIF spec 1.0.3 and 1.0.4, and a new helper m
 - getting start or end anchor points on annotations objects only with `targets` are no longer require the targets list is already sorted
 - sphinx-based public API documentation for old versions is back
 
+
 ## releasing 1.0.10 (2024-03-01)
 ### Overview
 This version includes minor bug fixes and support for MMIF spec 1.0.2. 
@@ -198,6 +232,7 @@ This version includes minor bug fixes and support for MMIF spec 1.0.2.
 * ISO-like time unit conversion now consistently returns only to third decimal place.
 
 
+
 ## releasing 1.0.9 (2024-02-10)
 ### Overview
 This is a feature-packed release.
@@ -213,6 +248,7 @@ This is a feature-packed release.
 * `Annotation` objects' `properties` attribute is no longer limited to primitives and list of primitives (https://github.com/clamsproject/mmif/issues/215)
 * Fixed annotation URI equivalence checker wasn't working in set-like collections (https://github.com/clamsproject/mmif-python/issues/257)
 
+
 ## releasing 1.0.8 (2023-07-24)
 ### Overview
 This release includes polishing and bug fixes around the `mmif.utils.video_document_helper` module.
@@ -224,6 +260,7 @@ This release includes polishing and bug fixes around the `mmif.utils.video_docum
 * `Annotation.get_property` now provide more intuitive access to "view-level" annotation properties found in `view.metadata.contains.some_at_type` dict 
 
 
+
 ## releasing 1.0.7 (2023-07-20)
 ### Overview
 Minor updates in VideoDucment helper module
@@ -233,6 +270,7 @@ Minor updates in VideoDucment helper module
 
 
 
+
 ## releasing 1.0.6 (2023-07-19)
 ### Overview
 This release relaxes checks for optional CV dependencies in video utils module, so that users don't have install all of `[cv]` dependencies when they don't use them all. 
@@ -241,6 +279,7 @@ This release relaxes checks for optional CV dependencies in video utils module,
 * when any of `[cv]` dependencies is not found during `mmif.utils.video_document_helper` module is being loaded, instead of raising and an error, a warning is issued.
 
 
+
 ## releasing 1.0.5 (2023-07-19)
 ### Overview
 This release contains a minor fix in video_document_helper module
@@ -249,11 +288,13 @@ This release contains a minor fix in video_document_helper module
 * fixed time unit normalization was missing some important string
 
 
+
 ## releasing 1.0.4 (2023-07-19)
 ### Overview
 This release fixes installation error in the previous version. 
 
 
+
 ## releasing 1.0.3 (2023-07-19)
 ### Overview
 This release is primarily about adding `mmif.utils` package and `mmif.utils.video_document_helper` module. The module provides many helper functions to handle frame-based and time-based documents and annotations. 
@@ -266,6 +307,7 @@ This release is primarily about adding `mmif.utils` package and `mmif.utils.vide
 * fixed bug in `Annotation.get_property` (#232)
 
 
+
 ## releasing 1.0.2 (2023-07-11)
 ### Overview
 This release includes support for plugins, and a "magic" helper for using `Annotation` annotations for documents in MMIF. 
@@ -277,6 +319,7 @@ This release includes support for plugins, and a "magic" helper for using `Annot
 
 
 
+
 ## releasing 1.0.1 (2023-05-26)
 ### Overview
 `mmif-python` 1.0.0 included MMIF 0.5.0 instead of  MMIF 1.0.0. This release fixes it
@@ -284,11 +327,13 @@ This release includes support for plugins, and a "magic" helper for using `Annot
 ### Changes
 * now based on MMIF specification 1.0.0
 
+
 ## releasing 1.0.0 (2023-05-25)
 ### Overview
 This release will be numbered as 1.0.0, but actually is re-numbering of 0.5.2, hence no technical changes are included in 1.0.0. 
 
 
+
 ## releasing 0.5.2 (2023-05-19)
 ### Overview
 This release fixes an oversight bug in `__eq__` in `MmifObject`s. Also includes updates of the sphinx documentation. 
@@ -298,6 +343,7 @@ This release fixes an oversight bug in `__eq__` in `MmifObject`s. Also includes
 * Updated sphinx documentation (#215 )
 
 
+
 ## releasing 0.5.1 (2023-05-02)
 ### Overview
 This release includes "fuzzy" matching of at_types and sanitized `serialize` of `Mmif` objects.
@@ -313,6 +359,7 @@ This release includes "fuzzy" matching of at_types and sanitized `serialize` of
 * fixed a small bug in `Mmif.get_alignments` 
 * fixed `view.metadata` serialized into an invalid MMIF due to a *oneOf* condition in jsonschema
 
+
 ## releasing 0.5.0 (2023-04-30)
 ### Overview
 This release is a synchronization of `mmif-python` with the latest [MMIF 0.5.0 release](https://github.com/clamsproject/mmif/pull/199). 
@@ -321,9 +368,11 @@ This release is a synchronization of `mmif-python` with the latest [MMIF 0.5.0 r
 * Enum-like subclasses for annotation `@type`s in the `mmif.vocabulary` package are updated to accommodate the new way of checking I/O compatibility (as `__eq__()` in the SDK).
 
 
+
 ## releasing 0.4.8 (2023-02-10)
 This is a small PR that doesn't include any code in the SDK, but the target MMIF version is bumped up to [0.4.2](https://github.com/clamsproject/mmif/blob/master/CHANGELOG.md#version-042---2023-02-09). 
 
+
 ## releasing 0.4.7 (2023-02-09)
 This release includes
 
@@ -331,12 +380,14 @@ This release includes
 * made `properties` map to behave like a map (#194)
 * updated python dependencies (#196, #198)
 
+
 ## releasing 0.4.6 (2022-03-25)
 This release includes 
 
 * fixes in the development & release pipelines. (#189 #187)
 * upgrade in the text retrieval from TextDocument (#185)
 
+
 ## releasing 0.4.5 (2021-07-11)
 This release contains minor bug fixes
 
@@ -344,23 +395,29 @@ This release contains minor bug fixes
 * fixed how `develop` version of vocab URIs were handled
 * colon (`:`) is now a class constant for gluing view_id and annotation_id
 
+
 ## releasing 0.4.4 (2021-06-19)
 This release contains small but breaking changes. See d5198cb2304ad488975644a87fba51906abc5299 for details. 
 
 
+
 ## releasing 0.4.3 (2021-06-18)
 This release fixes minor bugs from the previous version.
 
 
+
 ## releasing 0.4.2 (2021-06-17)
 This release adds `new_textdocument` helper method to `View` class. 
 
+
 ## releasing 0.4.1 (2021-06-14)
 The release contains a small bug fix in deserialization of `Mmif` object. 
 
+
 ## releasing 0.4.0  (2021-06-10)
 New release to correspond to the MMIF specification 0.4.0. 
 
+
 ## releasing 0.3.5 (2021-06-05)
 The release includes ...
 
@@ -370,19 +427,24 @@ The release includes ...
 * various bug fixes and clean-up
 
 
+
 ## releasing 0.3.4 (2021-05-24)
 This release includes major bug fixes (#131, #164) and a new documentation generation pipeline (#167). 
 
+
 ## releasing 0.3.3 (2021-05-12)
 This release contains various bug fixes. 
 
+
 ## releasing 0.3.2 (2021-05-12)
 A version to match changes in the specification 0.3.1. 
 
+
 ## releasing 0.3.1 (2021-03-30)
 0.3.1 contains mostly small bugfixes.
 
 
+
 ## release candidate for 0.3.0 (2021-03-14)
 release note for mmif-python 0.3.0
 

{mmif_python-1.4.0/mmif_python.egg-info → mmif_python-1.5.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: mmif-python
-Version: 1.4.0
+Version: 1.5.0
 Summary: Python implementation of MultiMedia Interchange Format specification. (https://mmif.clams.ai)
 License-Expression: Apache-2.0
 Project-URL: homepage, https://mmif.clams.ai
 Project-URL: source, https://github.com/clamsproject/mmif-python
-Project-URL: mmif-spec, https://mmif.clams.ai/1.1.1
+Project-URL: mmif-spec, https://mmif.clams.ai/1.2.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3 :: Only

{mmif_python-1.4.0 → mmif_python-1.5.0}/build-tools/docs.py

@@ -109,10 +109,6 @@ def build_versioned_docs(env: Venv, source_path: Path, version: str):
     print("\n--- Installing sphinx and furo theme ---")
     env.run_pip("install", "sphinx>=7.0,<8.0", "furo", "m2r2", cwd=source_path)
 
-    # Write VERSION file (needed for setup.py and sphinx)
-    version_file = source_path / "VERSION"
-    version_file.write_text(version)
-
     # Inject linkcode_resolve function into conf.py for GitHub source links
     # because some old version of conf.py may not have it
     print("\n--- Injecting linkcode_resolve into conf.py ---")
@@ -148,10 +144,16 @@ def linkcode_resolve(domain, info):
         with open(conf_py, "a") as f:
             f.write(linkcode_snippet)
 
-    # Install package in develop mode to generate code (ver, res, vocabulary)
-    # Uses setup.py develop for compatibility with all versions
-    print("\n--- Installing package in develop mode ---")
-    env.run_python("setup.py", "develop", cwd=source_path)
+    # Install package in editable mode so sphinx-autodoc can import it.
+    # Pre-1.4.0 releases ship setup.py with build-time code generation that
+    # needs a VERSION file; 1.4.0+ releases are pyproject-only and version
+    # themselves from git tags via setuptools-scm.
+    print("\n--- Installing package in editable mode ---")
+    if (source_path / "setup.py").exists():
+        (source_path / "VERSION").write_text(version)
+        env.run_python("setup.py", "develop", cwd=source_path)
+    else:
+        env.run_pip("install", "-e", ".", cwd=source_path)
 
     # Build documentation with sphinx-build
     print("\n--- Building Sphinx documentation ---")
@@ -216,8 +218,8 @@ def build_docs_for_version(version: str, output_base_dir: Path, repo_path: Path
         print(f"\n--- Step 2: Creating and setting up virtual environment ---")
         env = Venv(venv_path)
         env.create()
-        # Use setuptools<80 for compatibility with older setup.py files
-        # that use the old import structure
+        # setuptools<80 pin keeps the legacy `python setup.py develop` path
+        # working for pre-1.4.0 tags; harmless for pyproject-only tags.
         env.run_pip("install", "--upgrade", "pip", "setuptools<80", "wheel")
 
         print(f"\n--- Step 3: Building documentation ---")

{mmif_python-1.4.0 → mmif_python-1.5.0}/mmif/res/mmif.json

@@ -64,6 +64,14 @@
           "format": "uri",
           "minLength": 7
         },
+        "appTags": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "uniqueItems": true
+        },
         "contains": {
           "type": "object",
           "additionalProperties": false,
@@ -98,6 +106,15 @@
         },
         "appConfiguration": {
           "type": "object"
+        },
+        "appProfiling": {
+          "type": "object",
+          "properties": {
+            "runningTime": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
         }
       },
       "oneOf": [