CWL 2 Markdown
CWL to Markdown Transpiler-Mate plugin. It generates one Markdown page per CWL
workflow and renders document-level Schema.org SoftwareApplication metadata.
Quick start
Install the plugin and runtime in the same Python environment:
python -m pip install cwl2markdown transpiler-mate-runtime
Generate pages from a metadata-bearing CWL document:
transpiler-mate cwl2markdown --output build/docs workflow.cwl
See the first-steps tutorial for a complete Schema.org metadata example.
Project conventions
This project is templated a Hatch-based Python package with:
- Apache-2.0 license
- Keep a Changelog-compatible
CHANGELOG.md - Diátaxis documentation under
docs/ - top-level
mkdocs.yaml - Taskfile integration with
Terradue/taskfile-utils - GitHub Actions CI
Documentation
Project documentation is published at: https://Transpiler-Mate.github.io/cwl2markdown/
Contribute
Submit a Github issue if you have comments or suggestions.
Local quality checks
Install Hatch and Taskfiles 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
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 cwl2markdown-0.1.0.tar.gz.
File metadata
- Download URL: cwl2markdown-0.1.0.tar.gz
- Upload date:
- Size: 15.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae2389a7dd5d4c4cf0726b161cc5ad50cc9f7124c3a576b1b7ecfc4c19398d22
|
|
| MD5 |
9077a6d4066056326443fffc197bded9
|
|
| BLAKE2b-256 |
c5f67a7276097cd10c5ee616cea31138a3fa8df929c581eadcd29f016c6f9fe1
|
Provenance
The following attestation bundles were made for cwl2markdown-0.1.0.tar.gz:
Publisher:
package.yaml on transpiler-mate/cwl2markdown
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cwl2markdown-0.1.0.tar.gz -
Subject digest:
ae2389a7dd5d4c4cf0726b161cc5ad50cc9f7124c3a576b1b7ecfc4c19398d22 - Sigstore transparency entry: 2770650031
- Sigstore integration time:
-
Permalink:
transpiler-mate/cwl2markdown@552072539b18ca2974bbdee5d5ccd3a73763117d -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/transpiler-mate
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
package.yaml@552072539b18ca2974bbdee5d5ccd3a73763117d -
Trigger Event:
push
-
Statement type:
File details
Details for the file cwl2markdown-0.1.0-py3-none-any.whl.
File metadata
- Download URL: cwl2markdown-0.1.0-py3-none-any.whl
- Upload date:
- Size: 13.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b4738db2ba7c98076c490cffd55c728cfdbc3888a472a76e25be8558eb71ec1
|
|
| MD5 |
5bb73d2b907e53b6aa6df72f3cc4fa6c
|
|
| BLAKE2b-256 |
2e02946366533d0bf7a599db16d51b0aad3baa0ee2a3a138f37b74f5007eef94
|
Provenance
The following attestation bundles were made for cwl2markdown-0.1.0-py3-none-any.whl:
Publisher:
package.yaml on transpiler-mate/cwl2markdown
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cwl2markdown-0.1.0-py3-none-any.whl -
Subject digest:
8b4738db2ba7c98076c490cffd55c728cfdbc3888a472a76e25be8558eb71ec1 - Sigstore transparency entry: 2770650104
- Sigstore integration time:
-
Permalink:
transpiler-mate/cwl2markdown@552072539b18ca2974bbdee5d5ccd3a73763117d -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/transpiler-mate
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
package.yaml@552072539b18ca2974bbdee5d5ccd3a73763117d -
Trigger Event:
push
-
Statement type:
