Skip to content

Conversation

@keighrim
Copy link
Member

Overview

Updated output formats of the experimental mmif describe command

Changes

  • mmif describe command
    • simplified output JSON format of single-mmif input (mmif.utils.workflow_helper.describe_single_mmif)
    • more informative output from multi-mmif input (mmif.utils.workflow_helper.describe_mmif_collection)

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.

- a new mmif.utils.workflow helper module to offer
    - common hashing implementation for app parameters
    - common CLAMS workflow ID calculation based on the hashing
    - summarizing MMIF file(s)
- CLI wrappers are provided as `mmif rewind` and `mmif describe` cmds
- all the CLI cmds are now properly show up in built documentation
rmore refinement to `mmif describe` cmd
@clams-bot clams-bot added this to infra Nov 28, 2025
@github-project-automation github-project-automation bot moved this to Todo in infra Nov 28, 2025
@keighrim keighrim merged commit f2869b0 into main Nov 28, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in infra Nov 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants