Invenio Publisher Transpiler-Mate Plugin¶

invenio-publish turns the Schema.org metadata attached to a Common Workflow Language (CWL) document into a published InvenioRDM record. It is a Transpiler-Mate plugin, not a standalone command.

The plugin uses invenio-rest-api-client, a dedicated client for the InvenioRDM REST API. It supports both InvenioRDM installations and Zenodo:

metadata without an identifier creates a new draft and reserves a DOI;
metadata with an existing DOI creates a new version of that record;
in both cases, requested files are uploaded, the metadata is updated, and the draft is published.

Warning

Running the plugin publishes the resulting draft. Start with an InvenioRDM test instance or Zenodo Sandbox.

Use these docs by intent:

Tutorials: learn by completing a guided path.
How-to guides: solve specific tasks.
Reference: look up commands, APIs, and configuration.
Explanation: understand design decisions and concepts.

Quick start¶

python -m pip install invenio-publish transpiler-mate-runtime
export INVENIO_TOKEN="your-access-token"
transpiler-mate invenio-publish \
  --base-url https://sandbox.zenodo.org/ \
  --auth-token "$INVENIO_TOKEN" \
  --attach workflow.cwl \
  workflow.cwl

Follow Publish your first record for a complete CWL example, or go directly to create or update a record.