cwl2puml

cwl2puml converts Common Workflow Language workflows into PlantUML diagrams.

It provides a CLI that can:

load a CWL workflow from a local path or URL
render PlantUML source files
optionally render PNG or SVG images through a PlantUML server

Supported Diagrams

activity
component
class
sequence
state

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, strict mypy checks, and the pytest suite. Run the complete hook explicitly with:

task quality:pre-commit:run

Installation

Install from the repository:

pip install .

For development:

pip install hatch

CLI Usage

Show the CLI help:

cwl2puml --help

Basic example:

cwl2puml \
  https://raw.githubusercontent.com/eoap/application-package-patterns/refs/heads/main/cwl-workflow/pattern-1.cwl \
  --workflow-id pattern-1 \
  --output ./out

This writes one .puml file per diagram type into ./out.

Generate only selected diagrams:

cwl2puml workflow.cwl \
  --workflow-id main \
  --diagrams component \
  --diagrams sequence \
  --output ./out

Generate SVG images through a PlantUML server:

cwl2puml workflow.cwl \
  --workflow-id main \
  --diagrams component \
  --output ./out \
  --convert-image \
  --image-format svg

Use a custom PlantUML server host:

cwl2puml workflow.cwl \
  --workflow-id main \
  --output ./out \
  --convert-image \
  --puml-server uml.planttext.com

Output

For each selected diagram type, the CLI writes:

<diagram>.puml
optionally <diagram>.png or <diagram>.svg

Development

Run the test matrix:

hatch run test:test-q

Run coverage:

hatch run test:test-cov

Run formatting checks:

hatch run dev:lint

Run Ruff fixes:

hatch run dev:check

Documentation

Project documentation: https://Terradue.github.io/cwl2puml/

Contributing

Open an issue at https://github.com/Terradue/cwl2puml/issues if you find a bug or want to propose a change.

License

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cwl2puml-0.45.0.tar.gz (9.6 MB view details)

Uploaded Jul 28, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cwl2puml-0.45.0-py3-none-any.whl (17.3 kB view details)

Uploaded Jul 28, 2026 Python 3

File details

Details for the file cwl2puml-0.45.0.tar.gz.

File metadata

Download URL: cwl2puml-0.45.0.tar.gz
Upload date: Jul 28, 2026
Size: 9.6 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for cwl2puml-0.45.0.tar.gz
Algorithm	Hash digest
SHA256	`1c27e14f799f128e584838ca1520f4210fde6ed13a6eec0b1655ba3eba211f01`
MD5	`3b641731211592ab5e8d7d14615a88c2`
BLAKE2b-256	`1a5569e89c3052292b901bdd1455fd61f87abd8ba072879a5325fda4c69a45c7`

See more details on using hashes here.

Provenance

The following attestation bundles were made for cwl2puml-0.45.0.tar.gz:

Publisher: package.yaml on Terradue/cwl2puml

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: cwl2puml-0.45.0.tar.gz
- Subject digest: 1c27e14f799f128e584838ca1520f4210fde6ed13a6eec0b1655ba3eba211f01
- Sigstore transparency entry: 2269162136
- Sigstore integration time: Jul 28, 2026
Source repository:
- Permalink: Terradue/cwl2puml@a2e33e0215be63ddbbe36957843be5502f3cbbc9
- Branch / Tag: refs/tags/v0.45.0
- Owner: https://github.com/Terradue
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: package.yaml@a2e33e0215be63ddbbe36957843be5502f3cbbc9
- Trigger Event: push