Install¶

Python 3.10 or later is required. The package depends on transpiler-mate-api, Loguru, and PySTAC (>1,<2).

Use the published package¶

python -m pip install cwl2ogcrecords

For command-line conversion, the transpiler-mate CLI must also be installed in the same environment. This package registers a plugin entry point; it does not install a standalone cwl2ogcrecords executable.

Verify plugin discovery:

transpiler-mate --help
transpiler-mate cwl2ogcrecords --help

If the command is missing, check that the CLI and plugin use the same Python environment. Direct Python use only needs the package:

from cwl2ogcrecords.ogc_record import OGCRecord

Work from source¶

git clone https://github.com/Transpiler-Mate/cwl2ogcrecords
cd cwl2ogcrecords
python -m pip install -e .

Preview documentation¶

From the repository root:

python -m pip install mkdocs 'mkdocstrings[python]' pymdown-extensions
python -m mkdocs serve -f mkdocs.yaml

To check the complete site without serving it:

python -m mkdocs build --strict -f mkdocs.yaml