Plugin template

Changes:

• migarted to freva-plugin-template
• divided shell script into multiple scripts (one for actual processing, one storing functions)
• setup functional testing
• added test data
• added basic informations to the output

Please have a look if the right licences were used and if any important part from the template is missing. The main objective for now was to get the plugin running using the freva-plugin-template. Additional improvements regarding code quality and input generalization will be done as soon as we switch to cmorized data.

Closes #1 (closed)

.reuse/add_license.py

+"""Helper script to add licenses to files.
+
+This script can be used to apply the licenses and default copyright holders
+to files in the repository.
+
+It uses the short cuts from the ``.reuse/shortcuts.yaml`` file and
+adds them to the call of ``reuse annotate``. Any command line option however
+overwrites the config in ``shortcuts.yaml``
+
+Usage::
+
+    python .reuse/add_license.py <shortcut> <path> [OPTIONS]
+"""
+
+import os.path as osp
+from argparse import ArgumentParser
+from pathlib import Path
+from textwrap import dedent
+from typing import Dict, Optional, TypedDict
+
+import yaml
+from reuse.project import Project
+
+try:
+    from reuse._annotate import add_arguments as _orig_add_arguments
+    from reuse._annotate import run
+except ImportError:
+    # reuse < 3.0
+    from reuse.header import add_arguments as _orig_add_arguments
+    from reuse.header import run
+
+
+class LicenseShortCut(TypedDict):
+    """Shortcut to add a copyright statement"""
+
+    #: The copyright statement
+    copyright: str
+
+    #: year of copyright statement
+    year: str
+
+    #: SPDX Identifier of the license
+    license: Optional[str]
+
+
+def load_shortcuts() -> Dict[str, LicenseShortCut]:
+    """Load the ``shortcuts.yaml`` file."""
+
+    with open(osp.join(osp.dirname(__file__), "shortcuts.yaml")) as f:
+        return yaml.safe_load(f)
+
+
+def add_arguments(
+    parser: ArgumentParser, shortcuts: Dict[str, LicenseShortCut]
+):
+    parser.add_argument(
+        "shortcut",
+        choices=[key for key in shortcuts if not key.startswith(".")],
+        help=(
+            "What license should be applied? Shortcuts are loaded from "
+            ".reuse/shortcuts.yaml. Possible shortcuts are %(choices)s"
+        ),
+    )
+
+    _orig_add_arguments(parser)
+
+    parser.set_defaults(func=run)
+    parser.set_defaults(parser=parser)
+
+
+def main(argv=None):
+    shortcuts = load_shortcuts()
+
+    parser = ArgumentParser(
+        prog=".reuse/add_license.py",
+        description=dedent(
+            """
+            Add copyright and licensing into the header of files with shortcuts
+
+            This script uses the ``reuse annotate`` command to add copyright
+            and licensing information into the header the specified files.
+
+            It accepts the same arguments as ``reuse annotate``, plus an
+            additional required `shortcuts` argument. The given `shortcut`
+            comes from the file at ``.reuse/shortcuts.yaml`` to fill in
+            copyright, year and license identifier.
+
+            For further information, please type ``reuse annotate --help``"""
+        ),
+    )
+    add_arguments(parser, shortcuts)
+
+    args = parser.parse_args(argv)
+
+    shortcut = shortcuts[args.shortcut]
+
+    if args.year is None:
+        args.year = []
+    if args.copyright is None:
+        args.copyright = []
+
+    if args.license is None and shortcut.get("license"):
+        args.license = [shortcut["license"]]
+    elif args.license and shortcut.get("license"):
+        args.license.append(shortcut["license"])
+    args.year.append(shortcut["year"])
+    args.copyright.append(shortcut["copyright"])
+
+    project = Project(Path(__file__).parent.parent)
+    args.func(args, project)
+
+
+if __name__ == "__main__":
+    main()