Skip to content

Transpiler Mate

Transpiler Mate is a Python library and CLI that extracts Schema.org/SoftwareApplication metadata from annotated CWL documents and converts it into publication-ready formats.

It can generate CodeMeta, DataCite, OGC API - Records, OGC API - Processes, Markdown workflow documentation, and OCI annotations. It can also publish records to InvenioRDM and bump CWL software versions according to Semantic Versioning.

Documentation map

This documentation is organized with the Diataxis framework:

  • Tutorials are for learning a workflow from start to finish.
  • How-to guides are for completing a concrete task.
  • Reference is for looking up commands, schemas, crosswalks, and generated API details.
  • Explanation is for understanding the metadata model and conventions behind the tool.

Installation

pip install transpiler-mate

Common commands

transpiler-mate codemeta ./metadata.cwl --output ./dist/codemeta.json
transpiler-mate datacite ./metadata.cwl --output ./dist/datacite.json
transpiler-mate ogcrecord ./metadata.cwl --output ./dist/record.json
transpiler-mate markdown ./workflow.cwl --workflow-id main --output ./docs
transpiler-mate oci-annotations ./workflow.cwl --workflow-id main --output annotations.json

Use the how-to guides for task-specific options and examples.