cwl2ogcrecords 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,40 @@
1
+ # Copyright {{ copyright_year }} {{ author_name }}
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ # Python
16
+ __pycache__/
17
+ *.py[cod]
18
+ *.egg-info/
19
+ .dist/
20
+ build/
21
+ dist/
22
+ .coverage
23
+ coverage.xml
24
+ .pytest_cache/
25
+ .mypy_cache/
26
+ .ruff_cache/
27
+
28
+ # Environments
29
+ .venv/
30
+
31
+ # MkDocs
32
+ site/
33
+
34
+ # Editors
35
+ .idea/
36
+ .vscode/
37
+ .DS_Store
38
+
39
+ .task
40
+ uv.lock
@@ -0,0 +1,47 @@
1
+ <!--
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ -->
16
+
17
+ # Changelog
18
+
19
+ All notable changes to this project will be documented in this file.
20
+
21
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
22
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
23
+
24
+ ## [Unreleased]
25
+
26
+ ### Added
27
+
28
+ ### Changed
29
+
30
+ ### Deprecated
31
+
32
+ ### Removed
33
+
34
+ ### Fixed
35
+
36
+ ### Security
37
+
38
+ ### Added
39
+
40
+ ## [0.1.0] - 2026-09-18
41
+
42
+ ### Added
43
+
44
+ - Initial project release.
45
+
46
+ [Unreleased]: https://github.com/Transpiler-Mate/cwl2ogcrecords/compare/0.1.0...HEAD
47
+ [0.1.0]: https://github.com/Transpiler-Mate/cwl2ogcrecords/releases/tag/0.1.0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Transpiler-Mate
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,4 @@
1
+ CWL to OGC API - Records
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ This product includes software developed by Transpiler-Mate.
@@ -0,0 +1,91 @@
1
+ Metadata-Version: 2.5
2
+ Name: cwl2ogcrecords
3
+ Version: 0.1.0
4
+ Summary: CWL to OGC API - Records Transpiler-Mate Plugin.
5
+ Project-URL: Homepage, https://github.com/Transpiler-Mate/cwl2ogcrecords
6
+ Project-URL: Documentation, https://Transpiler-Mate.github.io/cwl2ogcrecords/
7
+ Project-URL: Repository, https://github.com/Transpiler-Mate/cwl2ogcrecords
8
+ Project-URL: Issues, https://github.com/Transpiler-Mate/cwl2ogcrecords/issues
9
+ Project-URL: Changelog, https://github.com/Transpiler-Mate/cwl2ogcrecords/blob/main/CHANGELOG.md
10
+ Author-email: Transpiler-Mate <info@terradue.com>
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ License-File: NOTICE
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: License :: OSI Approved :: Apache Software License
17
+ Classifier: Programming Language :: Python
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.14
23
+ Classifier: Programming Language :: Python :: Implementation :: CPython
24
+ Classifier: Programming Language :: Python :: Implementation :: PyPy
25
+ Requires-Python: >=3.10
26
+ Requires-Dist: loguru==0.7.3
27
+ Requires-Dist: pystac<2,>1
28
+ Requires-Dist: transpiler-mate-api==1.0.0
29
+ Description-Content-Type: text/markdown
30
+
31
+ <!--
32
+ Copyright 2026 Transpiler-Mate
33
+
34
+ Licensed under the Apache License, Version 2.0 (the "License");
35
+ you may not use this file except in compliance with the License.
36
+ You may obtain a copy of the License at
37
+
38
+ http://www.apache.org/licenses/LICENSE-2.0
39
+
40
+ Unless required by applicable law or agreed to in writing, software
41
+ distributed under the License is distributed on an "AS IS" BASIS,
42
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
43
+ See the License for the specific language governing permissions and
44
+ limitations under the License.
45
+ -->
46
+
47
+ # CWL to OGC API - Records
48
+
49
+ [![PyPI - Version](https://img.shields.io/pypi/v/cwl2ogcrecords.svg)](https://pypi.org/project/cwl2ogcrecords)
50
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cwl2ogcrecords.svg)](https://pypi.org/project/cwl2ogcrecords)
51
+
52
+ CWL to OGC API - Records Transpiler-Mate Plugin.
53
+
54
+ ## Project conventions
55
+
56
+ This project is templated a Hatch-based Python package with:
57
+
58
+ - Apache-2.0 license
59
+ - Keep a Changelog-compatible `CHANGELOG.md`
60
+ - Diátaxis documentation under `docs/`
61
+ - top-level `mkdocs.yaml`
62
+ - Taskfile integration with `Terradue/taskfile-utils`
63
+ - GitHub Actions CI
64
+
65
+ ## Documentation
66
+
67
+ Project documentation is published at: https://Transpiler-Mate.github.io/cwl2ogcrecords/
68
+
69
+ ## Contribute
70
+
71
+ Submit a [Github issue](https://github.com/Transpiler-Mate/cwl2ogcrecords/issues) if you have comments or suggestions.
72
+
73
+ ### Local quality checks
74
+
75
+ Install [Hatch](https://hatch.pypa.io/) and [Taskfiles](https://taskfile.dev/docs/guide) then install the Git hook:
76
+
77
+ ```console
78
+ task quality:pre-commit:install
79
+ ```
80
+
81
+ Every commit runs Ruff (including the configured McCabe complexity limit),
82
+ Ruff formatting, strict mypy checks, and the pytest suite.
83
+
84
+ Run the complete hook explicitly with:
85
+
86
+ ```console
87
+ task quality:pre-commit:run
88
+
89
+ ## License
90
+
91
+ [![Apache License, Version 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)
@@ -0,0 +1,61 @@
1
+ <!--
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ -->
16
+
17
+ # CWL to OGC API - Records
18
+
19
+ [![PyPI - Version](https://img.shields.io/pypi/v/cwl2ogcrecords.svg)](https://pypi.org/project/cwl2ogcrecords)
20
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cwl2ogcrecords.svg)](https://pypi.org/project/cwl2ogcrecords)
21
+
22
+ CWL to OGC API - Records Transpiler-Mate Plugin.
23
+
24
+ ## Project conventions
25
+
26
+ This project is templated a Hatch-based Python package with:
27
+
28
+ - Apache-2.0 license
29
+ - Keep a Changelog-compatible `CHANGELOG.md`
30
+ - Diátaxis documentation under `docs/`
31
+ - top-level `mkdocs.yaml`
32
+ - Taskfile integration with `Terradue/taskfile-utils`
33
+ - GitHub Actions CI
34
+
35
+ ## Documentation
36
+
37
+ Project documentation is published at: https://Transpiler-Mate.github.io/cwl2ogcrecords/
38
+
39
+ ## Contribute
40
+
41
+ Submit a [Github issue](https://github.com/Transpiler-Mate/cwl2ogcrecords/issues) if you have comments or suggestions.
42
+
43
+ ### Local quality checks
44
+
45
+ Install [Hatch](https://hatch.pypa.io/) and [Taskfiles](https://taskfile.dev/docs/guide) then install the Git hook:
46
+
47
+ ```console
48
+ task quality:pre-commit:install
49
+ ```
50
+
51
+ Every commit runs Ruff (including the configured McCabe complexity limit),
52
+ Ruff formatting, strict mypy checks, and the pytest suite.
53
+
54
+ Run the complete hook explicitly with:
55
+
56
+ ```console
57
+ task quality:pre-commit:run
58
+
59
+ ## License
60
+
61
+ [![Apache License, Version 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)
@@ -0,0 +1,52 @@
1
+ <!--
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ -->
16
+
17
+ # Architecture
18
+
19
+ ## Conversion flow
20
+
21
+ The Transpiler-Mate host resolves the CWL source and provides software metadata
22
+ in a `TranspilerContext`. The plugin maps that metadata to an `OGCRecord`, then
23
+ serializes a single GeoJSON Feature to the configured output path. It does not
24
+ serve an OGC API endpoint or publish the record to a catalog.
25
+
26
+ `plugin.py` owns the metadata mapping, defaults, and file output. `ogc_record.py`
27
+ owns the record representation, typed metadata dictionaries, and PySTAC adapter.
28
+ The [plugin reference](../reference/plugin.md) describes conversion-specific
29
+ assumptions; these are separate from the more permissive Python record model.
30
+
31
+ ## Why reuse PySTAC?
32
+
33
+ `OGCRecord` subclasses `pystac.Item` to reuse links, assets, and Item-oriented
34
+ extension APIs. Its default serialization is an OGC Record Feature. It initializes
35
+ `STACObject` directly to avoid requiring a STAC datetime for every record.
36
+ This dependency on PySTAC internals requires review when upgrading PySTAC.
37
+
38
+ OGC temporal extent and STAC datetime fields remain independent. Explicit
39
+ `to_stac_item()` export requires a real datetime or start/end interval; it does
40
+ not invent dates. See [record behavior](../reference/ogc_record.md).
41
+
42
+ ## Why typed dictionaries?
43
+
44
+ The record keeps metadata in a live properties dictionary. Typed dictionaries
45
+ provide named structures without changing JSON serialization or introducing
46
+ conversion wrappers. Shared structures are reused, including contact link
47
+ fields and required identifier values. Union aliases express the schema's
48
+ name-or-media-type and name-or-organization alternatives.
49
+
50
+ Static typing and schema validation remain separate. The package preserves
51
+ unknown metadata and exposes an explicit validator hook; it does not claim
52
+ that every constructed dictionary satisfies the complete OGC schema.
@@ -0,0 +1,19 @@
1
+ <!--
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ -->
16
+
17
+ # Explanation
18
+
19
+ Read [Architecture](architecture.md) for the conversion flow, PySTAC adapter design, and typing boundaries.
@@ -0,0 +1,20 @@
1
+ <!--
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ -->
16
+
17
+ # How-to guides
18
+
19
+ - [Install](install.md) the package and preview its documentation.
20
+ - [Convert a CWL source](use-cli.md) through Transpiler-Mate.
@@ -0,0 +1,67 @@
1
+ <!--
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ -->
16
+
17
+ # Install
18
+
19
+ Python 3.10 or later is required. The package depends on `transpiler-mate-api`,
20
+ Loguru, and PySTAC (`>1,<2`).
21
+
22
+ ## Use the published package
23
+
24
+ ```bash
25
+ python -m pip install cwl2ogcrecords
26
+ ```
27
+
28
+ For command-line conversion, the `transpiler-mate` CLI must also be installed
29
+ in the same environment. This package registers a plugin entry point; it does
30
+ not install a standalone `cwl2ogcrecords` executable.
31
+
32
+ Verify plugin discovery:
33
+
34
+ ```bash
35
+ transpiler-mate --help
36
+ transpiler-mate cwl2ogcrecords --help
37
+ ```
38
+
39
+ If the command is missing, check that the CLI and plugin use the same Python
40
+ environment. Direct Python use only needs the package:
41
+
42
+ ```python
43
+ from cwl2ogcrecords.ogc_record import OGCRecord
44
+ ```
45
+
46
+ ## Work from source
47
+
48
+ ```bash
49
+ git clone https://github.com/Transpiler-Mate/cwl2ogcrecords
50
+ cd cwl2ogcrecords
51
+ python -m pip install -e .
52
+ ```
53
+
54
+ ## Preview documentation
55
+
56
+ From the repository root:
57
+
58
+ ```bash
59
+ python -m pip install mkdocs 'mkdocstrings[python]' pymdown-extensions
60
+ python -m mkdocs serve -f mkdocs.yaml
61
+ ```
62
+
63
+ To check the complete site without serving it:
64
+
65
+ ```bash
66
+ python -m mkdocs build --strict -f mkdocs.yaml
67
+ ```
@@ -0,0 +1,56 @@
1
+ <!--
2
+ Copyright 2026 Transpiler-Mate
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ -->
16
+
17
+ # Convert a CWL source
18
+
19
+ Install the plugin in your Transpiler-Mate environment as described in
20
+ [Install](install.md). Check the command options:
21
+
22
+ ```bash
23
+ transpiler-mate cwl2ogcrecords --help
24
+ ```
25
+
26
+ ## Write a record
27
+
28
+ ```bash
29
+ transpiler-mate cwl2ogcrecords --output build/record.json workflow.cwl
30
+ ```
31
+
32
+ `SOURCE` is the positional CWL source handled by Transpiler-Mate. The plugin
33
+ receives the resolved context and software metadata. It writes one JSON Feature,
34
+ creates missing parent directories, and overwrites the selected file if it
35
+ already exists. Without `--output`, the destination is `ogc-record.json` in the
36
+ current directory.
37
+
38
+ Inspect the result:
39
+
40
+ ```bash
41
+ python -m json.tool build/record.json
42
+ ```
43
+
44
+ The result contains `id`, `type`, `geometry`, `properties`, and `links`. Metadata
45
+ such as title, language, themes, and contacts appears inside `properties`.
46
+ The plugin excludes self links when writing the file.
47
+
48
+ ## Prepare metadata
49
+
50
+ Review the [mapping and input assumptions](../reference/plugin.md) before
51
+ conversion. In particular, the current implementation expects creation date,
52
+ author contact details and affiliations, license information, and software-help
53
+ objects. Incomplete author or help metadata can fail during conversion.
54
+
55
+ The host CLI also exposes authentication options for source access. Use its
56
+ `--help` output for the options available in your installed version.