Skip to main content

CWL 2 Citation

PyPI - Version PyPI - Python Version GitHub Actions Workflow Status Code coverage

Generate a citation experience for CWL software with a Transpiler-Mate plugin: CFF, BibTeX, RIS, CSL-JSON, and styled text from the same metadata.

Bootstrapped from transpiler-mate-plugin-project-template.

Install

From this checkout (Python 3.10+):

pip install transpiler-mate-runtime .

Generate citations

transpiler-mate cwl2citation --output citations workflow.cwl#main
File Purpose
CITATION.cff Software citation metadata for GitHub and CFF consumers
citation.bib BibTeX @misc entry, including software version
citation.ris RIS COMP entry for reference managers
citation.csl.json CSL-JSON array containing one software record
citation.txt Plain-text bibliography entry, APA by default

Select formats and a citation style:

transpiler-mate cwl2citation --format bibtex --format text --style ieee \
  --released 2026-09-18 --output citations-ieee workflow.cwl#main

--doi, --url, and --code-repository provide optional publication metadata. --style accepts a packaged CSL style name or local independent CSL file; --locale defaults to en-US. Existing output files are never overwritten.

Citations use document-level Schema.org metadata parsed by Transpiler-Mate. A fragment validates the selected process; it does not create separate step-level citation metadata. Authors retain their order. Missing DOI and publication dates remain absent: dateCreated is not a release date. A DOI is read from the software identifier when present or supplied through --doi; the plugin does not mint or resolve DOIs.

CFF and CSL-JSON are schema-validated. Styled output uses citeproc-py and packaged CSL styles, so exact formatting depends on the style and processor support. These exports cite the workflow software; they do not reproduce every Zenodo record metadata export or publish to Zenodo.

See CLI documentation, metadata mapping, and third-party notices.

Development

pip install -e '.[test]'
pytest
hatch run dev:typecheck
hatch run dev:ruff check src tests
hatch run dev:ruff format --check src tests
hatch run dev:security
pip install -r requirements-docs.txt
mkdocs build --strict

License

Apache License, Version 2.0 for project code; bundled schemas retain their upstream licenses.

Metadata

Release files for cwl2citation 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cwl2citation 0.1.1
File Size Uploaded
cwl2citation-0.1.1.tar.gz 36.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cwl2citation 0.1.1
File Interpreter ABI Platform
cwl2citation-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 70.7 kB

Release files / cwl2citation-0.1.1.tar.gz

Download URL cwl2citation-0.1.1.tar.gz
Size 36.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b5a448af51eecbea0b9518513fe094ff6a1e62ed9a1f6e6d81880feead987e09
BLAKE2b-256 checksum
How to use checksums
407435473efc5d5ac6b2caf909a52b58a5efc86eb70d271e90568735b5cad3d1
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 28, 2026.

Transparency log

Release files / cwl2citation-0.1.1-py3-none-any.whl

Download URL cwl2citation-0.1.1-py3-none-any.whl
Size 34.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
576327e7ec56056a8d21242ff2f032cb36b552c0756a83015b5da7b753815c96
BLAKE2b-256 checksum
How to use checksums
1b0c3dc65093ffd694fb7f9aa0c688e9afd4d66cb985addcab1d07de06c05e1b
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 28, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page