releasing 1.5.0

[keighrim]

Overview

Improves image-extraction API in video_document_helper for TP source tracking, restores the source-composition prefix in workflow identifiers, and fixes the versioned-docs publishing pipeline.

Additions

• extract_images_by_count_with_sources and extract_images_by_mode_with_sources: new public functions in mmif.utils.video_document_helper that return per-image source IDs (or sampled timepoints in ms when a fallback path is used), so downstream apps can anchor each extracted image to a specific point in the source media (VDH image extractions now return source timepoints #385, vdh.extract_frames_by_mode should also return "source" information #384).

Changes

• mmif.utils.video_document_helper: renamed
  • extract_timepoints_as_images --> extract_images_from_timepoints,
  • extract_target_frames --> extract_images_by_count_with_sources (alongside new bare extract_images_by_count), and
  • extract_frames_by_mode --> extract_images_by_mode.
  • The three pre-rename names remain importable as soft-deprecated aliases through 2.0.0 (VDH image extractions now return source timepoints #385).
• mmif.utils.workflow_helper.generate_workflow_identifier: now prefixes a source_composition segment (TextDocument-1-VideoDocument-1/...) describing the top-level document mix in the input MMIF (brought back "source" information as part of workflowId #386).
• build-tools/docs.py: versioned-docs build now works against pyproject-only tags, restoring docs publishing in the release workflow (fixed docs.py for building old versions with setup.py #388, docs.py is broken on CI #387).

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.
• The new source_composition prefix in generate_workflow_identifier() changes the format of returned identifiers. Downstream tools parsing the identifier path (e.g. for storage-directory routing) may need to account for the extra leading segment.

[codecov]

Codecov Report

❌ Patch coverage is 87.67123% with 18 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.78%. Comparing base (cb6f952) to head (87ad065).
⚠️ Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
mmif/utils/video_document_helper.py	87.50%	18 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #389      +/-   ##
==========================================
+ Coverage   73.62%   74.78%   +1.15%     
==========================================
  Files          27       27              
  Lines        3204     3228      +24     
==========================================
+ Hits         2359     2414      +55     
+ Misses        845      814      -31     

Flag	Coverage Δ
unittests	74.78% <87.67%> (+1.15%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.