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.
What It Does
Given an input CWL metadata source, Transpiler Mate can:
- Generate CodeMeta JSON-LD.
- Generate DataCite metadata payloads.
- Generate OGC API - Records payloads.
- Generate Markdown documentation for workflows.
- Generate OCI Annotations.
- Bundle CWL documents into self-contained files with external references resolved.
- Publish records to InvenioRDM.
- Bump semantic versions in metadata files.
Documentation: https://terradue.github.io/transpiler-mate/
Supported Outputs
- CodeMeta: https://codemeta.github.io/
- DataCite Metadata: https://inveniordm.docs.cern.ch/reference/metadata/#metadata
- OGC API - Records: https://ogcapi.ogc.org/records/
- OCI Annotations: https://oras.land/docs/how_to_guides/manifest_annotations/
- InvenioRDM: https://inveniosoftware.org/products/rdm/
Requirements
- Python
>= 3.10
Installation
From source (recommended for development)
git clone https://github.com/Terradue/transpiler-mate.git
cd transpiler-mate
pip install -e .
Install tooling for local workflows
pip install hatch ruff
CLI Usage
Entry point:
transpiler-mate --help
Main commands:
transpiler-mate codemeta <source> [--code-repository URL] [--output codemeta.json]transpiler-mate datacite <source> [--output datacite.json]transpiler-mate ogcrecord <source> [--output record.json]transpiler-mate markdown <source> --workflow-id <id> [--output DIR] [--code-repository URL]transpiler-mate oci-annotations <source> --workflow-id <id> [--image-source URL] [--image-revision ] [--output annotations.json]transpiler-mate invenio-publish <source> --base-url URL --auth-token TOKEN [--attach FILE ...]transpiler-mate bump-version <source> [--version-part major|minor|patch|build|pre-release]transpiler-mate bundle <source> [--output bundle.cwl] [--oci-hostname HOST] [--oci-username USER] [--oci-password PASSWORD] [--oauth2-bearer TOKEN]
Examples
Generate CodeMeta:
transpiler-mate codemeta ./metadata.cwl --output ./dist/codemeta.json
Generate DataCite metadata:
transpiler-mate datacite ./metadata.cwl --output ./dist/datacite.json
Generate OGC Record:
transpiler-mate ogcrecord ./metadata.cwl --output ./dist/record.json
Generate Markdown documentation:
transpiler-mate markdown ./workflow.cwl --workflow-id main --output ./docs
Bundle a CWL document and resolve its external references:
transpiler-mate bundle ./workflow.cwl --output ./dist/bundle.cwl
The bundle command was migrated from the CWL Loader CLI.
Publish to InvenioRDM:
export INVENIO_AUTH_TOKEN="<token>"
transpiler-mate invenio-publish ./metadata.cwl --base-url https://invenio.example.org --auth-token "$INVENIO_AUTH_TOKEN"
Development
Run lint and formatting checks:
hatch run dev:check
hatch run dev:lint
Run tests for one interpreter:
hatch run test.py3.12:test-q
Run full Hatch test matrix (local environment permitting):
hatch run test:test-q
Project Tasks
Taskfile.yaml includes helper tasks for schema/model generation and quality checks:
task testtask checktask lint
License
Apache License 2.0. See LICENSE.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file transpiler_mate-0.47.0.tar.gz.
File metadata
- Download URL: transpiler_mate-0.47.0.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a844575e44a0471d4a89530959b4b15c55cd6fbc7276424145e09cab8f08e7e5
|
|
| MD5 |
b19e97f8f6d86e63d19c175004ee0e2f
|
|
| BLAKE2b-256 |
ee3dd4f6a2d3374fec5a9b0b516cf102e02913c0b1901d3fb450f4e56035ec74
|
Provenance
The following attestation bundles were made for transpiler_mate-0.47.0.tar.gz:
Publisher:
package.yaml on Terradue/transpiler-mate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
transpiler_mate-0.47.0.tar.gz -
Subject digest:
a844575e44a0471d4a89530959b4b15c55cd6fbc7276424145e09cab8f08e7e5 - Sigstore transparency entry: 2173457916
- Sigstore integration time:
-
Permalink:
Terradue/transpiler-mate@cf2a3b3cc6268ff74ccb2d5902529cd0be9376e3 -
Branch / Tag:
refs/tags/v0.47.0 - Owner: https://github.com/Terradue
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
package.yaml@cf2a3b3cc6268ff74ccb2d5902529cd0be9376e3 -
Trigger Event:
push
-
Statement type:
File details
Details for the file transpiler_mate-0.47.0-py3-none-any.whl.
File metadata
- Download URL: transpiler_mate-0.47.0-py3-none-any.whl
- Upload date:
- Size: 247.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92e53efabf83080fab01c686404bdc2fc17be7ba354ba28d34a4a04a5e21b578
|
|
| MD5 |
87659857e27630729a6c7483ee479b4c
|
|
| BLAKE2b-256 |
7a3db003ac81eb9bca16de85a7266820012d0bfac61bfe8de1ef4445a302c25c
|
Provenance
The following attestation bundles were made for transpiler_mate-0.47.0-py3-none-any.whl:
Publisher:
package.yaml on Terradue/transpiler-mate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
transpiler_mate-0.47.0-py3-none-any.whl -
Subject digest:
92e53efabf83080fab01c686404bdc2fc17be7ba354ba28d34a4a04a5e21b578 - Sigstore transparency entry: 2173457947
- Sigstore integration time:
-
Permalink:
Terradue/transpiler-mate@cf2a3b3cc6268ff74ccb2d5902529cd0be9376e3 -
Branch / Tag:
refs/tags/v0.47.0 - Owner: https://github.com/Terradue
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
package.yaml@cf2a3b3cc6268ff74ccb2d5902529cd0be9376e3 -
Trigger Event:
push
-
Statement type:
