codemeta-drift 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.
- codemeta_drift-0.1.0/LICENSE +201 -0
- codemeta_drift-0.1.0/PKG-INFO +209 -0
- codemeta_drift-0.1.0/README.md +196 -0
- codemeta_drift-0.1.0/pyproject.toml +117 -0
- codemeta_drift-0.1.0/pyproject.toml.orig +105 -0
- codemeta_drift-0.1.0/src/codemeta_drift/__init__.py +4 -0
- codemeta_drift-0.1.0/src/codemeta_drift/checks.py +243 -0
- codemeta_drift-0.1.0/src/codemeta_drift/cli.py +166 -0
- codemeta_drift-0.1.0/src/codemeta_drift/conformance.py +89 -0
- codemeta_drift-0.1.0/src/codemeta_drift/curated-3.1.json +207 -0
- codemeta_drift-0.1.0/src/codemeta_drift/export.py +246 -0
- codemeta_drift-0.1.0/src/codemeta_drift/mapping.schema.json +70 -0
- codemeta_drift-0.1.0/src/codemeta_drift/py.typed +0 -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 Simon van Lierde
|
|
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,209 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: codemeta-drift
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Report where CodeMeta's context, definitions, property table, examples and crosswalks disagree, and export the crosswalks as a JSON mapping
|
|
5
|
+
Author: Simon van Lierde
|
|
6
|
+
Author-email: Simon van Lierde <code@duinlab.nl>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Requires-Python: >=3.12
|
|
10
|
+
Project-URL: Homepage, https://github.com/simonvanlierde/codemeta-drift
|
|
11
|
+
Project-URL: Issues, https://github.com/simonvanlierde/codemeta-drift/issues
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
|
|
14
|
+
# codemeta-drift
|
|
15
|
+
|
|
16
|
+
[](https://github.com/simonvanlierde/codemeta-drift/actions/workflows/python.yml)
|
|
17
|
+
[](https://github.com/simonvanlierde/codemeta-drift/blob/main/LICENSE)
|
|
18
|
+
|
|
19
|
+
A small checker that finds the places where the CodeMeta standard's own files contradict
|
|
20
|
+
each other.
|
|
21
|
+
|
|
22
|
+
## Why this exists
|
|
23
|
+
|
|
24
|
+
[CodeMeta](https://codemeta.github.io) is a shared vocabulary for describing research
|
|
25
|
+
software: who wrote it, its licence, how to cite it, where the code lives. You put a
|
|
26
|
+
`codemeta.json` file next to your code, and archives such as Software Heritage can read it.
|
|
27
|
+
|
|
28
|
+
CodeMeta also publishes **crosswalks**: translation tables that say which field in another
|
|
29
|
+
format means the same thing. For example, a crosswalk says which field in a `CITATION.cff`
|
|
30
|
+
file, a PyPI package or a GitHub repository matches CodeMeta's `author` or `license`. There
|
|
31
|
+
are 46 of them, and tools use them to convert metadata from one format to another.
|
|
32
|
+
|
|
33
|
+
All of this lives in a handful of files that people edit by hand. When one file changes and
|
|
34
|
+
another doesn't, the translations go wrong without anyone noticing. A real example from
|
|
35
|
+
CodeMeta's main branch: the property list dropped `position` and put `maintainer` in its
|
|
36
|
+
place, but all 46 crosswalks still have a `position` row. If you lined them up by row number,
|
|
37
|
+
every format's "position" field would quietly turn into "maintainer".
|
|
38
|
+
|
|
39
|
+
codemeta-drift reads all those files and lists every place they disagree, so they can be
|
|
40
|
+
fixed before anyone converts metadata with them.
|
|
41
|
+
|
|
42
|
+
## Try it
|
|
43
|
+
|
|
44
|
+
Install it with [uv](https://docs.astral.sh/uv/) and point it at a copy of the CodeMeta
|
|
45
|
+
repository:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
uv tool install codemeta-drift
|
|
49
|
+
git clone https://github.com/codemeta/codemeta
|
|
50
|
+
codemeta-drift codemeta # check the files as they are
|
|
51
|
+
codemeta-drift codemeta --ref 4.0 # check any release, branch or commit instead
|
|
52
|
+
codemeta-drift codemeta --json # the same, as JSON
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Each line of output is one problem: what kind it is, the file, the term, and what's wrong.
|
|
56
|
+
For example:
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
CROSSWALK_ROWS crosswalks/*.csv (all 46): position: line 44 is not in properties_description.csv; the table has maintainer there
|
|
60
|
+
EXAMPLE_NO_TERM examples/codemeta.json: softwareSuggestions: not a term of codemeta.jsonld
|
|
61
|
+
AGGREGATE_FORMAT crosswalk.csv: GitLab: no column for crosswalks/GitLab.csv
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
When everything agrees, it prints nothing. That makes it usable in CI, where the exit code
|
|
65
|
+
is what counts:
|
|
66
|
+
|
|
67
|
+
- 0: the files agree.
|
|
68
|
+
- 1: they don't.
|
|
69
|
+
- 2: it couldn't check: the vocabulary or the property list is missing, or a file can't be read.
|
|
70
|
+
|
|
71
|
+
`--json` prints one document: `{"version": 1, "tool": {"name", "version"}, "findings": [...]}`.
|
|
72
|
+
Each finding has a `code`, a `file`, a `term` and a `detail`. `code` and `term` are stable; `file`
|
|
73
|
+
is a label (it can name a group, such as `crosswalks/*.csv (all 46)`), and `detail` is text for a
|
|
74
|
+
person. A minor release may add keys; removing or retyping one bumps `version`. The command line,
|
|
75
|
+
the exit codes, the finding codes and the export format are the interface: the Python modules may
|
|
76
|
+
change in any 0.x release.
|
|
77
|
+
|
|
78
|
+
## What it found in CodeMeta (2026-10-13)
|
|
79
|
+
|
|
80
|
+
On CodeMeta's main branch (`e62eb75`):
|
|
81
|
+
|
|
82
|
+
- The property list has three terms (`encoding`, `fileFormat`, `softwareSuggestions`) that the
|
|
83
|
+
vocabulary file doesn't define, and the vocabulary has three (`archivedAt`,
|
|
84
|
+
`encodingFormat`, `featureList`) that the list leaves out.
|
|
85
|
+
- The main example uses `softwareSuggestions`, one of the undefined terms.
|
|
86
|
+
- The definitions file has a typo (`contiIntegration` for `contIntegration`) and still defines
|
|
87
|
+
`embargoDate`, which the vocabulary doesn't have. The vocabulary only has `embargoEndDate`.
|
|
88
|
+
- `funding` and `maintainer` point to different addresses in the definitions and the
|
|
89
|
+
vocabulary.
|
|
90
|
+
- Every crosswalk is missing the same 12 terms, and still has the old `position` row.
|
|
91
|
+
- The combined table that the website shows has no column for the GitLab and code.json
|
|
92
|
+
crosswalks.
|
|
93
|
+
|
|
94
|
+
Number of problems per check, for the last two releases and the main branch:
|
|
95
|
+
|
|
96
|
+
| Check | 3.1 | 4.0 | main |
|
|
97
|
+
| --- | --- | --- | --- |
|
|
98
|
+
| `TABLE_NO_TERM` | 0 | 4 | 3 |
|
|
99
|
+
| `TERM_NO_ROW` | 0 | 3 | 3 |
|
|
100
|
+
| `TABLE_NAMESPACE` | 0 | 2 | 2 |
|
|
101
|
+
| `DEFINITION_NO_TERM` | not checked | 2 | 2 |
|
|
102
|
+
| `DEFINITION_IRI` | not checked | 2 | 2 |
|
|
103
|
+
| `EXAMPLE_NO_TERM` | 0 | 1 | 1 |
|
|
104
|
+
| `CROSSWALK_ROWS` | 3 | 10 | 13 |
|
|
105
|
+
| `AGGREGATE_ROWS` | 2 | 12 | 15 |
|
|
106
|
+
| `AGGREGATE_FORMAT` | 0 | 2 | 2 |
|
|
107
|
+
|
|
108
|
+
3.1 has no definitions file, so those checks didn't run. The full output for 3.1 and 4.0 is
|
|
109
|
+
in [`tests/fixtures/`](https://github.com/simonvanlierde/codemeta-drift/blob/main/tests/fixtures/).
|
|
110
|
+
|
|
111
|
+
## The files it compares
|
|
112
|
+
|
|
113
|
+
| File | What it is |
|
|
114
|
+
| --- | --- |
|
|
115
|
+
| `codemeta.jsonld` | The vocabulary: every term and the web address that defines it |
|
|
116
|
+
| `codemeta_all.jsonld` | The definitions of CodeMeta's own terms (since 4.0) |
|
|
117
|
+
| `properties_description.csv` | The property list people read, one row per term |
|
|
118
|
+
| `codemeta.json`, `examples/*.json` | Example metadata that should only use defined terms |
|
|
119
|
+
| `crosswalks/*.csv` | One translation table per format, listing the same terms in the same order |
|
|
120
|
+
| `crosswalk.csv` | All crosswalks combined into one table, which the website shows |
|
|
121
|
+
|
|
122
|
+
## Every check
|
|
123
|
+
|
|
124
|
+
| Code | It reports |
|
|
125
|
+
| --- | --- |
|
|
126
|
+
| `TABLE_DUPLICATE` | A term listed twice under the same type in the property list |
|
|
127
|
+
| `TABLE_NO_TERM` | A term in the property list that the vocabulary doesn't define |
|
|
128
|
+
| `TERM_NO_ROW` | A term in the vocabulary that the property list leaves out |
|
|
129
|
+
| `TABLE_NAMESPACE` | A term the property list files under `schema:` but the vocabulary under `codemeta:`, or the other way round |
|
|
130
|
+
| `DEFINITION_NO_TERM` | A definition for a term the vocabulary doesn't have |
|
|
131
|
+
| `DEFINITION_IRI` | A term whose address differs between the definitions and the vocabulary |
|
|
132
|
+
| `EXAMPLE_NO_TERM` | An example that uses an undefined term |
|
|
133
|
+
| `CROSSWALK_ROWS` | A crosswalk whose terms don't match the property list |
|
|
134
|
+
| `CROSSWALK_FORMAT` | Two crosswalks for the same format |
|
|
135
|
+
| `AGGREGATE_ROWS` | The combined table's terms don't match the property list |
|
|
136
|
+
| `AGGREGATE_FORMAT` | A crosswalk missing from the combined table, or a column with no crosswalk |
|
|
137
|
+
| `SKIPPED` | A file this version doesn't have; the checks that need it don't run, and it doesn't count as a problem |
|
|
138
|
+
|
|
139
|
+
The crosswalk checks compare terms by name, never by position. A renamed term shows up as one
|
|
140
|
+
term that shouldn't be there and one that's missing. When all 46 crosswalks have the same
|
|
141
|
+
problem, it's reported once.
|
|
142
|
+
|
|
143
|
+
All the checks live in one file, [`checks.py`](https://github.com/simonvanlierde/codemeta-drift/blob/main/src/codemeta_drift/checks.py). It needs
|
|
144
|
+
nothing beyond Python itself, so the CodeMeta repository could copy it into its own CI.
|
|
145
|
+
|
|
146
|
+
## Mapping export
|
|
147
|
+
|
|
148
|
+
A mapping export is a JSON file that says where each CodeMeta term sits in CFF, codemeta.json,
|
|
149
|
+
.zenodo.json, pyproject.toml, Cargo.toml and package.json, with wrong crosswalk cells corrected.
|
|
150
|
+
[docs/mapping-export.md](https://github.com/simonvanlierde/codemeta-drift/blob/main/docs/mapping-export.md) describes the format, and
|
|
151
|
+
[examples/mapping-3.1.json](https://github.com/simonvanlierde/codemeta-drift/blob/main/examples/mapping-3.1.json) is the one for CodeMeta 3.1.
|
|
152
|
+
|
|
153
|
+
```sh
|
|
154
|
+
codemeta-drift export codemeta --tag 3.1 --out mapping-3.1.json
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
A row reads its crosswalk cell when the cell is a path, such as `package.version`. Every other
|
|
158
|
+
row comes from [`curated-3.1.json`](https://github.com/simonvanlierde/codemeta-drift/blob/main/src/codemeta_drift/curated-3.1.json), which gives the path and
|
|
159
|
+
the reason: the cell is prose (`license / license-url`), empty, or wrong (`package.keyword`), or
|
|
160
|
+
the format has no crosswalk (PEP 621). A cell that is none of these is refused, not guessed:
|
|
161
|
+
|
|
162
|
+
```text
|
|
163
|
+
CELL_PROSE crosswalks/Citation File Format 1.2.0.csv: license: prose cell 'license / license-url', and no curated row
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
It then lists them on standard error, exits 1 and writes nothing. The rows are read from the tag's commit, not the working
|
|
167
|
+
tree, because each one says which tag it came from. A curated row records the cell it was written
|
|
168
|
+
for, and is reported as `CURATED_STALE` when that cell changes. Two terms whose paths are equal or
|
|
169
|
+
nested, such as Cargo's `name` cell `package.authors` beside `author`, are `PATH_SHARED`. Cells are matched to the property list by name, and a name
|
|
170
|
+
listed twice (`identifier` under Thing and under Person) by its order among the rows with that
|
|
171
|
+
name. Only tags with a curated file can be exported; for now that is 3.1. A checkout directory
|
|
172
|
+
named `export` needs a `./` in front.
|
|
173
|
+
|
|
174
|
+
`--schemas DIR` also checks every path against the format's own JSON Schema and reports
|
|
175
|
+
`PATH_NOT_IN_SCHEMA` for a key the schema doesn't have. The schemas for CFF 1.2.0, pyproject.toml,
|
|
176
|
+
package.json and Cargo.toml are in [`tests/fixtures/schemas/`](https://github.com/simonvanlierde/codemeta-drift/blob/main/tests/fixtures/schemas/), with
|
|
177
|
+
their sources. Zenodo has no current published schema for `.zenodo.json`, so its paths are not
|
|
178
|
+
checked. On the raw 3.1 crosswalk the check finds Cargo's `package.keyword`. It can't find a
|
|
179
|
+
path that exists but means something else, such as Zenodo's `identifier` cell `id`.
|
|
180
|
+
|
|
181
|
+
## Development
|
|
182
|
+
|
|
183
|
+
You need [uv](https://docs.astral.sh/uv/), [just](https://just.systems) and
|
|
184
|
+
[prek](https://github.com/j178/prek).
|
|
185
|
+
|
|
186
|
+
```sh
|
|
187
|
+
uv sync
|
|
188
|
+
uv tool install prek # once per machine
|
|
189
|
+
prek install # git hooks
|
|
190
|
+
just check # lint, types, tests and the dependency audit (needs network)
|
|
191
|
+
just hooks # the YAML, Markdown, workflow and citation checks CI also runs
|
|
192
|
+
just mutation # mutation-test the checks and the export (not in CI)
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
`just mutation` changes `checks.py`, `export.py` and `conformance.py` one small step at a time and fails if the tests
|
|
196
|
+
still pass on a change that `tests/mutation-baseline.txt` does not list. A change that
|
|
197
|
+
cannot alter behaviour goes in that file with the reason. It also fails on a listed
|
|
198
|
+
change the tests now catch, so the list stays true.
|
|
199
|
+
|
|
200
|
+
The tests run against real files from CodeMeta 3.1 and 4.0, copied byte for byte into
|
|
201
|
+
`tests/fixtures/`. The `.expected` files next to them hold the output the tool should give.
|
|
202
|
+
When you change the output on purpose, check the difference, then regenerate with
|
|
203
|
+
`uv run codemeta-drift tests/fixtures/<tag> > tests/fixtures/<tag>.expected` (it exits 1,
|
|
204
|
+
because both releases have problems).
|
|
205
|
+
|
|
206
|
+
## License
|
|
207
|
+
|
|
208
|
+
Apache-2.0, see [LICENSE](https://github.com/simonvanlierde/codemeta-drift/blob/main/LICENSE). The test fixtures are CodeMeta's own files, also
|
|
209
|
+
Apache-2.0; see [NOTICE](https://github.com/simonvanlierde/codemeta-drift/blob/main/NOTICE).
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
# codemeta-drift
|
|
2
|
+
|
|
3
|
+
[](https://github.com/simonvanlierde/codemeta-drift/actions/workflows/python.yml)
|
|
4
|
+
[](https://github.com/simonvanlierde/codemeta-drift/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
A small checker that finds the places where the CodeMeta standard's own files contradict
|
|
7
|
+
each other.
|
|
8
|
+
|
|
9
|
+
## Why this exists
|
|
10
|
+
|
|
11
|
+
[CodeMeta](https://codemeta.github.io) is a shared vocabulary for describing research
|
|
12
|
+
software: who wrote it, its licence, how to cite it, where the code lives. You put a
|
|
13
|
+
`codemeta.json` file next to your code, and archives such as Software Heritage can read it.
|
|
14
|
+
|
|
15
|
+
CodeMeta also publishes **crosswalks**: translation tables that say which field in another
|
|
16
|
+
format means the same thing. For example, a crosswalk says which field in a `CITATION.cff`
|
|
17
|
+
file, a PyPI package or a GitHub repository matches CodeMeta's `author` or `license`. There
|
|
18
|
+
are 46 of them, and tools use them to convert metadata from one format to another.
|
|
19
|
+
|
|
20
|
+
All of this lives in a handful of files that people edit by hand. When one file changes and
|
|
21
|
+
another doesn't, the translations go wrong without anyone noticing. A real example from
|
|
22
|
+
CodeMeta's main branch: the property list dropped `position` and put `maintainer` in its
|
|
23
|
+
place, but all 46 crosswalks still have a `position` row. If you lined them up by row number,
|
|
24
|
+
every format's "position" field would quietly turn into "maintainer".
|
|
25
|
+
|
|
26
|
+
codemeta-drift reads all those files and lists every place they disagree, so they can be
|
|
27
|
+
fixed before anyone converts metadata with them.
|
|
28
|
+
|
|
29
|
+
## Try it
|
|
30
|
+
|
|
31
|
+
Install it with [uv](https://docs.astral.sh/uv/) and point it at a copy of the CodeMeta
|
|
32
|
+
repository:
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
uv tool install codemeta-drift
|
|
36
|
+
git clone https://github.com/codemeta/codemeta
|
|
37
|
+
codemeta-drift codemeta # check the files as they are
|
|
38
|
+
codemeta-drift codemeta --ref 4.0 # check any release, branch or commit instead
|
|
39
|
+
codemeta-drift codemeta --json # the same, as JSON
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Each line of output is one problem: what kind it is, the file, the term, and what's wrong.
|
|
43
|
+
For example:
|
|
44
|
+
|
|
45
|
+
```text
|
|
46
|
+
CROSSWALK_ROWS crosswalks/*.csv (all 46): position: line 44 is not in properties_description.csv; the table has maintainer there
|
|
47
|
+
EXAMPLE_NO_TERM examples/codemeta.json: softwareSuggestions: not a term of codemeta.jsonld
|
|
48
|
+
AGGREGATE_FORMAT crosswalk.csv: GitLab: no column for crosswalks/GitLab.csv
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
When everything agrees, it prints nothing. That makes it usable in CI, where the exit code
|
|
52
|
+
is what counts:
|
|
53
|
+
|
|
54
|
+
- 0: the files agree.
|
|
55
|
+
- 1: they don't.
|
|
56
|
+
- 2: it couldn't check: the vocabulary or the property list is missing, or a file can't be read.
|
|
57
|
+
|
|
58
|
+
`--json` prints one document: `{"version": 1, "tool": {"name", "version"}, "findings": [...]}`.
|
|
59
|
+
Each finding has a `code`, a `file`, a `term` and a `detail`. `code` and `term` are stable; `file`
|
|
60
|
+
is a label (it can name a group, such as `crosswalks/*.csv (all 46)`), and `detail` is text for a
|
|
61
|
+
person. A minor release may add keys; removing or retyping one bumps `version`. The command line,
|
|
62
|
+
the exit codes, the finding codes and the export format are the interface: the Python modules may
|
|
63
|
+
change in any 0.x release.
|
|
64
|
+
|
|
65
|
+
## What it found in CodeMeta (2026-10-13)
|
|
66
|
+
|
|
67
|
+
On CodeMeta's main branch (`e62eb75`):
|
|
68
|
+
|
|
69
|
+
- The property list has three terms (`encoding`, `fileFormat`, `softwareSuggestions`) that the
|
|
70
|
+
vocabulary file doesn't define, and the vocabulary has three (`archivedAt`,
|
|
71
|
+
`encodingFormat`, `featureList`) that the list leaves out.
|
|
72
|
+
- The main example uses `softwareSuggestions`, one of the undefined terms.
|
|
73
|
+
- The definitions file has a typo (`contiIntegration` for `contIntegration`) and still defines
|
|
74
|
+
`embargoDate`, which the vocabulary doesn't have. The vocabulary only has `embargoEndDate`.
|
|
75
|
+
- `funding` and `maintainer` point to different addresses in the definitions and the
|
|
76
|
+
vocabulary.
|
|
77
|
+
- Every crosswalk is missing the same 12 terms, and still has the old `position` row.
|
|
78
|
+
- The combined table that the website shows has no column for the GitLab and code.json
|
|
79
|
+
crosswalks.
|
|
80
|
+
|
|
81
|
+
Number of problems per check, for the last two releases and the main branch:
|
|
82
|
+
|
|
83
|
+
| Check | 3.1 | 4.0 | main |
|
|
84
|
+
| --- | --- | --- | --- |
|
|
85
|
+
| `TABLE_NO_TERM` | 0 | 4 | 3 |
|
|
86
|
+
| `TERM_NO_ROW` | 0 | 3 | 3 |
|
|
87
|
+
| `TABLE_NAMESPACE` | 0 | 2 | 2 |
|
|
88
|
+
| `DEFINITION_NO_TERM` | not checked | 2 | 2 |
|
|
89
|
+
| `DEFINITION_IRI` | not checked | 2 | 2 |
|
|
90
|
+
| `EXAMPLE_NO_TERM` | 0 | 1 | 1 |
|
|
91
|
+
| `CROSSWALK_ROWS` | 3 | 10 | 13 |
|
|
92
|
+
| `AGGREGATE_ROWS` | 2 | 12 | 15 |
|
|
93
|
+
| `AGGREGATE_FORMAT` | 0 | 2 | 2 |
|
|
94
|
+
|
|
95
|
+
3.1 has no definitions file, so those checks didn't run. The full output for 3.1 and 4.0 is
|
|
96
|
+
in [`tests/fixtures/`](https://github.com/simonvanlierde/codemeta-drift/blob/main/tests/fixtures/).
|
|
97
|
+
|
|
98
|
+
## The files it compares
|
|
99
|
+
|
|
100
|
+
| File | What it is |
|
|
101
|
+
| --- | --- |
|
|
102
|
+
| `codemeta.jsonld` | The vocabulary: every term and the web address that defines it |
|
|
103
|
+
| `codemeta_all.jsonld` | The definitions of CodeMeta's own terms (since 4.0) |
|
|
104
|
+
| `properties_description.csv` | The property list people read, one row per term |
|
|
105
|
+
| `codemeta.json`, `examples/*.json` | Example metadata that should only use defined terms |
|
|
106
|
+
| `crosswalks/*.csv` | One translation table per format, listing the same terms in the same order |
|
|
107
|
+
| `crosswalk.csv` | All crosswalks combined into one table, which the website shows |
|
|
108
|
+
|
|
109
|
+
## Every check
|
|
110
|
+
|
|
111
|
+
| Code | It reports |
|
|
112
|
+
| --- | --- |
|
|
113
|
+
| `TABLE_DUPLICATE` | A term listed twice under the same type in the property list |
|
|
114
|
+
| `TABLE_NO_TERM` | A term in the property list that the vocabulary doesn't define |
|
|
115
|
+
| `TERM_NO_ROW` | A term in the vocabulary that the property list leaves out |
|
|
116
|
+
| `TABLE_NAMESPACE` | A term the property list files under `schema:` but the vocabulary under `codemeta:`, or the other way round |
|
|
117
|
+
| `DEFINITION_NO_TERM` | A definition for a term the vocabulary doesn't have |
|
|
118
|
+
| `DEFINITION_IRI` | A term whose address differs between the definitions and the vocabulary |
|
|
119
|
+
| `EXAMPLE_NO_TERM` | An example that uses an undefined term |
|
|
120
|
+
| `CROSSWALK_ROWS` | A crosswalk whose terms don't match the property list |
|
|
121
|
+
| `CROSSWALK_FORMAT` | Two crosswalks for the same format |
|
|
122
|
+
| `AGGREGATE_ROWS` | The combined table's terms don't match the property list |
|
|
123
|
+
| `AGGREGATE_FORMAT` | A crosswalk missing from the combined table, or a column with no crosswalk |
|
|
124
|
+
| `SKIPPED` | A file this version doesn't have; the checks that need it don't run, and it doesn't count as a problem |
|
|
125
|
+
|
|
126
|
+
The crosswalk checks compare terms by name, never by position. A renamed term shows up as one
|
|
127
|
+
term that shouldn't be there and one that's missing. When all 46 crosswalks have the same
|
|
128
|
+
problem, it's reported once.
|
|
129
|
+
|
|
130
|
+
All the checks live in one file, [`checks.py`](https://github.com/simonvanlierde/codemeta-drift/blob/main/src/codemeta_drift/checks.py). It needs
|
|
131
|
+
nothing beyond Python itself, so the CodeMeta repository could copy it into its own CI.
|
|
132
|
+
|
|
133
|
+
## Mapping export
|
|
134
|
+
|
|
135
|
+
A mapping export is a JSON file that says where each CodeMeta term sits in CFF, codemeta.json,
|
|
136
|
+
.zenodo.json, pyproject.toml, Cargo.toml and package.json, with wrong crosswalk cells corrected.
|
|
137
|
+
[docs/mapping-export.md](https://github.com/simonvanlierde/codemeta-drift/blob/main/docs/mapping-export.md) describes the format, and
|
|
138
|
+
[examples/mapping-3.1.json](https://github.com/simonvanlierde/codemeta-drift/blob/main/examples/mapping-3.1.json) is the one for CodeMeta 3.1.
|
|
139
|
+
|
|
140
|
+
```sh
|
|
141
|
+
codemeta-drift export codemeta --tag 3.1 --out mapping-3.1.json
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
A row reads its crosswalk cell when the cell is a path, such as `package.version`. Every other
|
|
145
|
+
row comes from [`curated-3.1.json`](https://github.com/simonvanlierde/codemeta-drift/blob/main/src/codemeta_drift/curated-3.1.json), which gives the path and
|
|
146
|
+
the reason: the cell is prose (`license / license-url`), empty, or wrong (`package.keyword`), or
|
|
147
|
+
the format has no crosswalk (PEP 621). A cell that is none of these is refused, not guessed:
|
|
148
|
+
|
|
149
|
+
```text
|
|
150
|
+
CELL_PROSE crosswalks/Citation File Format 1.2.0.csv: license: prose cell 'license / license-url', and no curated row
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
It then lists them on standard error, exits 1 and writes nothing. The rows are read from the tag's commit, not the working
|
|
154
|
+
tree, because each one says which tag it came from. A curated row records the cell it was written
|
|
155
|
+
for, and is reported as `CURATED_STALE` when that cell changes. Two terms whose paths are equal or
|
|
156
|
+
nested, such as Cargo's `name` cell `package.authors` beside `author`, are `PATH_SHARED`. Cells are matched to the property list by name, and a name
|
|
157
|
+
listed twice (`identifier` under Thing and under Person) by its order among the rows with that
|
|
158
|
+
name. Only tags with a curated file can be exported; for now that is 3.1. A checkout directory
|
|
159
|
+
named `export` needs a `./` in front.
|
|
160
|
+
|
|
161
|
+
`--schemas DIR` also checks every path against the format's own JSON Schema and reports
|
|
162
|
+
`PATH_NOT_IN_SCHEMA` for a key the schema doesn't have. The schemas for CFF 1.2.0, pyproject.toml,
|
|
163
|
+
package.json and Cargo.toml are in [`tests/fixtures/schemas/`](https://github.com/simonvanlierde/codemeta-drift/blob/main/tests/fixtures/schemas/), with
|
|
164
|
+
their sources. Zenodo has no current published schema for `.zenodo.json`, so its paths are not
|
|
165
|
+
checked. On the raw 3.1 crosswalk the check finds Cargo's `package.keyword`. It can't find a
|
|
166
|
+
path that exists but means something else, such as Zenodo's `identifier` cell `id`.
|
|
167
|
+
|
|
168
|
+
## Development
|
|
169
|
+
|
|
170
|
+
You need [uv](https://docs.astral.sh/uv/), [just](https://just.systems) and
|
|
171
|
+
[prek](https://github.com/j178/prek).
|
|
172
|
+
|
|
173
|
+
```sh
|
|
174
|
+
uv sync
|
|
175
|
+
uv tool install prek # once per machine
|
|
176
|
+
prek install # git hooks
|
|
177
|
+
just check # lint, types, tests and the dependency audit (needs network)
|
|
178
|
+
just hooks # the YAML, Markdown, workflow and citation checks CI also runs
|
|
179
|
+
just mutation # mutation-test the checks and the export (not in CI)
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
`just mutation` changes `checks.py`, `export.py` and `conformance.py` one small step at a time and fails if the tests
|
|
183
|
+
still pass on a change that `tests/mutation-baseline.txt` does not list. A change that
|
|
184
|
+
cannot alter behaviour goes in that file with the reason. It also fails on a listed
|
|
185
|
+
change the tests now catch, so the list stays true.
|
|
186
|
+
|
|
187
|
+
The tests run against real files from CodeMeta 3.1 and 4.0, copied byte for byte into
|
|
188
|
+
`tests/fixtures/`. The `.expected` files next to them hold the output the tool should give.
|
|
189
|
+
When you change the output on purpose, check the difference, then regenerate with
|
|
190
|
+
`uv run codemeta-drift tests/fixtures/<tag> > tests/fixtures/<tag>.expected` (it exits 1,
|
|
191
|
+
because both releases have problems).
|
|
192
|
+
|
|
193
|
+
## License
|
|
194
|
+
|
|
195
|
+
Apache-2.0, see [LICENSE](https://github.com/simonvanlierde/codemeta-drift/blob/main/LICENSE). The test fixtures are CodeMeta's own files, also
|
|
196
|
+
Apache-2.0; see [NOTICE](https://github.com/simonvanlierde/codemeta-drift/blob/main/NOTICE).
|