cwl2puml
cwl2puml converts Common Workflow Language workflows into PlantUML diagrams.
It provides a Python API and a transpiler-mate plugin that write PlantUML source and optionally render PNG or SVG images through a PlantUML server.
Supported Diagrams
activity, component, class, sequence, state,
ogc_processes_inputs, and ogc_processes_outputs.
Requirements
- Python
>=3.10
Local quality checks
Install Hatch and Taskfiles and then install the Git hook:
task quality:pre-commit:install
Every commit runs Ruff (including the configured McCabe complexity limit), Ruff formatting, mypy checks, Bandit security checks, and the pytest suite. Run the complete hook explicitly with:
task quality:pre-commit:run
Installation
For command-line use, install the runtime and plugin together:
pip install transpiler-mate-runtime "cwl2puml>=0.48.0"
For the Python library alone, use pip install cwl2puml. To install the current
checkout, use pip install ..
CLI Usage
transpiler-mate cwl2puml --help
transpiler-mate cwl2puml --output ./out 'workflow.cwl#main'
Omit #main to render all workflows. Select diagram types by repeating
--diagrams, and optionally request images:
transpiler-mate cwl2puml \
--diagrams component \
--diagrams sequence \
--output ./out \
--convert-image \
--image-format svg \
'workflow.cwl#main'
Output
The plugin writes <output>/<workflow.id>/<diagram>.puml, plus .png or .svg
files when image conversion is enabled. The default output directory is
./docs; images are disabled by default. All seven diagram types are selected
unless --diagrams is supplied.
Start with the first-diagram tutorial, or see the command-line guide and Python guide for specific tasks. Options and API signatures are in the reference.
Development
Install Hatch with pip install hatch, then run the test matrix:
hatch run test:test
Run coverage:
hatch run test:test-cov
Format the code:
hatch run dev:lint
Run Ruff fixes:
hatch run dev:check
Documentation
Project documentation: https://Terradue.github.io/cwl2puml/
To preview the documentation locally, use an isolated environment:
python3 -m venv .venv
source .venv/bin/activate
python -m pip install mkdocs mkdocs-mermaid2-plugin mkdocs-jupyter "mkdocstrings[python]" pymdown-extensions
mkdocs serve
Run mkdocs build --strict to validate the documentation. Notebook pages use
their saved outputs; regenerate those outputs in Jupyter when updating examples.
Contributing
Open an issue at https://github.com/Terradue/cwl2puml/issues if you find a bug or want to propose a change.
License
1 maintainer
Metadata
1 maintainer
Release files for cwl2puml 0.49.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cwl2puml-0.49.1.tar.gz | 291.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cwl2puml-0.49.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 309.3 kB
Release files / cwl2puml-0.49.1.tar.gz
| Download URL | cwl2puml-0.49.1.tar.gz |
|---|---|
| Size | 291.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4e4dac851887b661a3a27f32396df1260fe298672fcfe29bf960649d66840349
|
|
BLAKE2b-256 checksum How to use checksums |
909a5d109e61d1a1470a476f8d35c0d340bb583cbb6efc566b2f40793dcdb6d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 27, 2026.
Transparency logRelease files / cwl2puml-0.49.1-py3-none-any.whl
| Download URL | cwl2puml-0.49.1-py3-none-any.whl |
|---|---|
| Size | 17.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4b101df97ae412e08165c18dd9bc72f2c18461f5640aafea7556ea5202634efd
|
|
BLAKE2b-256 checksum How to use checksums |
f03aede35697c7731f10a4e1de41d0a9cd7e50f78815e1cb9712e165f7e40cf0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 27, 2026.
Transparency log
