-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This tool can take the data from AUTHORS and CONTRIBUTORS and merge it into the appropriate codemeta.json sections. This is really a merge: If things already exist, they will be updated. Also apply it the first time.
- Loading branch information
1 parent
947c4a7
commit 415232b
Showing
2 changed files
with
180 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| #! /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'): | ||
| 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): | ||
| 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+)>)?$') | ||
| 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() |