build: Support updating the .zenodo.json metadata

codemeta_update.py

@@ -1,87 +0,0 @@
-#! /usr/bin/env python3
-# Copyright (C) 2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
-#
-# SPDX-License-Identifier: LGPL-3.0-or-later
-
-
-import argparse
-import json
-import re
-from collections import OrderedDict
-
-
-class CodeMetaManipulator(object):
-    def load(self, filename='codemeta.json'):
-        with open(filename, 'rb') as fp:
-            self.data = json.load(fp, object_pairs_hook=OrderedDict)
-
-    @staticmethod
-    def _dict_entry_cmp(dict1, dict2, field):
-        if (field in dict1) and (field in dict2):
-            return dict1[field] == dict2[field]
-        else:
-            return False
-
-    @classmethod
-    def find_person_entry(cls, person_list, matchdict):
-        for entry in person_list:
-            if cls._dict_entry_cmp(entry, matchdict, 'email'):
-                return entry
-            if cls._dict_entry_cmp(entry, matchdict, 'familyName') \
-                    and cls._dict_entry_cmp(entry, matchdict, 'givenName'):
-                return entry
-        return None
-
-    @staticmethod
-    def update_person_entry(entry, matchdict):
-        if entry is None:
-            entry = OrderedDict()
-            entry['@type'] = 'Person'
-        for field in ('givenName', 'familyName', 'email', 'orcid'):
-            val = matchdict.get(field, None)
-            if val is not None:
-                if field == 'orcid':
-                    entry['@id'] = val
-                else:
-                    entry[field] = val
-        return entry
-
-    def handle_person_list_file(self, filename, cm_field_name):
-        fp = open(filename, 'r', encoding='utf8')
-        findregex = re.compile(r'^(?P<familyName>[-\w\s]*[-\w]),\s*'
-                               r'(?P<givenName>[-\w\s]*[-\w])\s*'
-                               r'(?:<(?P<email>\S+@\S+)>)?\s*'
-                               r'(\[(?P<orcid>\S+)\])?$')
-        person_list = self.data.setdefault(cm_field_name, [])
-        for line in fp:
-            line = line.strip()
-            m = findregex.match(line)
-            if m is None:
-                raise RuntimeError("Could not analyze line %r" % line)
-            found_entry = self.find_person_entry(person_list, m.groupdict())
-            entry = self.update_person_entry(found_entry, m.groupdict())
-            if found_entry is None:
-                person_list.append(entry)
-
-    def save(self, filename='codemeta.json'):
-        with open('codemeta.json', 'w', encoding='utf8') as fp:
-            json.dump(self.data, fp, indent=2)
-            fp.write('\n')
-
-
-def main():
-    parser = argparse.ArgumentParser(description='Update codemeta.json')
-    parser.add_argument('--set-version', dest='newversion')
-    args = parser.parse_args()
-
-    cm = CodeMetaManipulator()
-    cm.load()
-    if args.newversion is not None:
-        cm.data['softwareVersion'] = args.newversion
-    cm.handle_person_list_file('AUTHORS', 'author')
-    cm.handle_person_list_file('CONTRIBUTORS', 'contributor')
-    cm.save()
-
-
-if __name__ == '__main__':
-    main()

meta_update.py

@@ -0,0 +1,153 @@
+#! /usr/bin/env python3
+# Copyright (C) 2021-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+
+import argparse
+import json
+import re
+from collections import OrderedDict
+
+
+class Manipulator(object):
+    def load(self, filename):
+        with open(filename, 'rb') as fp:
+            self.data = json.load(fp, object_pairs_hook=OrderedDict)
+
+    @staticmethod
+    def _dict_entry_cmp(dict1, dict2, field):
+        if (field in dict1) and (field in dict2):
+            return dict1[field] == dict2[field]
+        else:
+            return False
+
+    def save(self, filename, indent=2):
+        with open(filename, 'w', encoding='utf8') as fp:
+            json.dump(self.data, fp, indent=indent)
+            fp.write('\n')
+
+
+class CodeMetaManipulator(Manipulator):
+    def load(self, filename='codemeta.json'):
+        super().load(filename)
+
+    @classmethod
+    def find_person_entry(cls, person_list, matchdict):
+        for entry in person_list:
+            if cls._dict_entry_cmp(entry, matchdict, 'email'):
+                return entry
+            if cls._dict_entry_cmp(entry, matchdict, 'familyName') \
+                    and cls._dict_entry_cmp(entry, matchdict, 'givenName'):
+                return entry
+        return None
+
+    @staticmethod
+    def update_person_entry(entry, matchdict):
+        if entry is None:
+            entry = OrderedDict()
+            entry['@type'] = 'Person'
+        for field in ('givenName', 'familyName', 'email', 'orcid'):
+            val = matchdict.get(field, None)
+            if val is not None:
+                if field == 'orcid':
+                    entry['@id'] = val
+                else:
+                    entry[field] = val
+        return entry
+
+    def handle_person_list_file(self, filename, cm_field_name):
+        fp = open(filename, 'r', encoding='utf8')
+        findregex = re.compile(r'^(?P<familyName>[-\w\s]*[-\w]),\s*'
+                               r'(?P<givenName>[-\w\s]*[-\w])\s*'
+                               r'(?:<(?P<email>\S+@\S+)>)?\s*'
+                               r'(\[(?P<orcid>\S+)\])?$')
+        person_list = self.data.setdefault(cm_field_name, [])
+        for line in fp:
+            line = line.strip()
+            m = findregex.match(line)
+            if m is None:
+                raise RuntimeError("Could not analyze line %r" % line)
+            found_entry = self.find_person_entry(person_list, m.groupdict())
+            entry = self.update_person_entry(found_entry, m.groupdict())
+            if found_entry is None:
+                person_list.append(entry)
+
+    def update_authors(self):
+        self.handle_person_list_file('AUTHORS', 'author')
+        self.handle_person_list_file('CONTRIBUTORS', 'contributor')
+
+    def save(self, filename='codemeta.json'):
+        super().save(filename)
+
+    def version(self, new_version):
+        self.data['softwareVersion'] = new_version
+
+
+class ZenodoManipulator(Manipulator):
+    def load(self, filename='.zenodo.json'):
+        super().load(filename)
+
+    @classmethod
+    def find_person_entry(cls, person_list, matchdict):
+        for entry in person_list:
+            if cls._dict_entry_cmp(entry, matchdict, 'name'):
+                return entry
+            if cls._dict_entry_cmp(entry, matchdict, 'orcid'):
+                return entry
+        return None
+
+    @staticmethod
+    def update_person_entry(entry, matchdict, contributors = False):
+        if entry is None:
+            entry = OrderedDict()
+            if contributors:
+                entry['type'] = 'Other'
+        for field in ('name', 'orcid'):
+            val = matchdict.get(field, None)
+            if val is not None:
+                entry[field] = val
+        return entry
+
+    def handle_person_list_file(self, filename, cm_field_name, contributors = False):
+        fp = open(filename, 'r', encoding='utf8')
+        findregex = re.compile(r'^(?P<name>[-\w\s,]*[-\w])\s*'
+                               r'(?:<(?P<email>\S+@\S+)>)?\s*'
+                               r'(\[https://orcid\.org/(?P<orcid>\S+)\])?$')
+        person_list = self.data.setdefault(cm_field_name, [])
+        for line in fp:
+            line = line.strip()
+            m = findregex.match(line)
+            if m is None:
+                raise RuntimeError("Could not analyze line %r" % line)
+            found_entry = self.find_person_entry(person_list, m.groupdict())
+            entry = self.update_person_entry(found_entry, m.groupdict(), contributors)
+            if found_entry is None:
+                person_list.append(entry)
+
+    def update_authors(self):
+        self.handle_person_list_file('AUTHORS', 'creators')
+        self.handle_person_list_file('CONTRIBUTORS', 'contributors', True)
+
+    def save(self, filename='.zenodo.json'):
+        super().save(filename, 4)
+
+    def version(self, new_version):
+        self.data['version'] = new_version
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Update codemeta.json and .zenodo.json')
+    parser.add_argument('--set-version', dest='newversion')
+    args = parser.parse_args()
+
+    for manipulator in (CodeMetaManipulator(), ZenodoManipulator()):
+        manipulator.load()
+        if args.newversion is not None:
+            manipulator.version(args.newversion)
+        manipulator.update_authors()
+        manipulator.save()
+
+
+if __name__ == '__main__':
+    main()