ceos-ard-cli 0.1.0__tar.gz

ceos_ard_cli-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ceos_ard_cli-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.2
+Name: ceos-ard-cli
+Version: 0.1.0
+Summary: CLI tools for CEOS-ARD
+Home-page: https://github.com/ceos-org/ceos-ard-cli
+Author: Matthias Mohr
+License: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: strictyaml>=1.7.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: weasyprint>=64.0
+Requires-Dist: bibtexparser==2.0.0b8
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+# CEOS-ARD CLI <!-- omit in toc -->
+
+CLI for working with the [CEOS-ARD building blocks and PFSes](https://github.com/ceos-org/ceos-ard).
+
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+  - [Execute a command](#execute-a-command)
+- [Commands](#commands)
+  - [`ceos-ard compile`: Compile PFS document to a Markdown file](#ceos-ard-compile-compile-pfs-document-to-a-markdown-file)
+  - [`ceos-ard generate`: Create Word/HTML/PDF documents for a single PFS](#ceos-ard-generate-create-wordhtmlpdf-documents-for-a-single-pfs)
+  - [`ceos-ard generate-all`: Create Word/HTML/PDF documents for all PFSes](#ceos-ard-generate-all-create-wordhtmlpdf-documents-for-all-pfses)
+  - [`ceos-ard validate`: Validate CEOS-ARD components](#ceos-ard-validate-validate-ceos-ard-components)
+- [Development](#development)
+
+## Getting Started
+
+In order to make working with CEOS-ARD easier we have developed command-line interface (CLI) tools.
+
+### Installation
+
+You will need to have **Python 3.9** or any later version installed.
+
+For the `generate` and `generate-all` commands you also need the following software installed:
+
+- pandoc 3.6 or later (for Word + HTML generation)
+- pandoc-crossref (for table/image/section references)
+- pango-view (for PDF generation)
+
+> ![NOTE]
+> The following command doesn't work yet as the package as not been published on pypi yet.
+> Please continue with the [Development](#development) instructions for now.
+
+Run `pip install ceos-ard-cli` in the CLI to install the tool.
+
+### Execute a command
+
+After the installation you should be able to run the following command: `ceos-ard`
+
+You should see usage instructions and [available commands](#commands) for the CLI.
+
+## Commands
+
+### `ceos-ard compile`: Compile PFS document to a Markdown file
+
+To compile a PFS document to a Markdown file, run: `ceos-ard compile SR`
+
+The last part is the PFS to create, e.g. `SR` or `SAR-NRB`.
+
+Check `ceos-ard compile --help` for more details.
+
+### `ceos-ard generate`: Create Word/HTML/PDF documents for a single PFS
+
+To create the Word, HTML, and PDF versions of a single PFS, run: `ceos-ard generate SR`
+
+The last part is the PFS to create, e.g. `SR` or `SAR-NRB`.
+
+Check `ceos-ard generate --help` for more details.
+
+### `ceos-ard generate-all`: Create Word/HTML/PDF documents for all PFSes
+
+To create the Word, HTML, and PDF versions for all PFSes, run: `ceos-ard generate-all`
+
+Check `ceos-ard generate-all --help` for more details.
+
+### `ceos-ard validate`: Validate CEOS-ARD components
+
+To validate (most of) the building blocks, run: `ceos-ard validate`
+
+Check `ceos-ard validate --help` for more details.
+
+## Development
+
+1. Install the dependencies (Python, Pandoc, pandoc-crossref, pango-view) as indicated in [Installation](#installation)
+2. Fork this repository if you plan to change the code or create pull requests.
+3. Clone either your forked repository or this repository, e.g. `git clone https://github.com/ceos-org/ceos-ard-cli`
+4. Switch into the newly created folder: `cd ceos-ard-cli`
+5. Install this package in development mode: `pip install -e .`

ceos_ard_cli-0.1.0/README.md

@@ -0,0 +1,77 @@
+# CEOS-ARD CLI <!-- omit in toc -->
+
+CLI for working with the [CEOS-ARD building blocks and PFSes](https://github.com/ceos-org/ceos-ard).
+
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+  - [Execute a command](#execute-a-command)
+- [Commands](#commands)
+  - [`ceos-ard compile`: Compile PFS document to a Markdown file](#ceos-ard-compile-compile-pfs-document-to-a-markdown-file)
+  - [`ceos-ard generate`: Create Word/HTML/PDF documents for a single PFS](#ceos-ard-generate-create-wordhtmlpdf-documents-for-a-single-pfs)
+  - [`ceos-ard generate-all`: Create Word/HTML/PDF documents for all PFSes](#ceos-ard-generate-all-create-wordhtmlpdf-documents-for-all-pfses)
+  - [`ceos-ard validate`: Validate CEOS-ARD components](#ceos-ard-validate-validate-ceos-ard-components)
+- [Development](#development)
+
+## Getting Started
+
+In order to make working with CEOS-ARD easier we have developed command-line interface (CLI) tools.
+
+### Installation
+
+You will need to have **Python 3.9** or any later version installed.
+
+For the `generate` and `generate-all` commands you also need the following software installed:
+
+- pandoc 3.6 or later (for Word + HTML generation)
+- pandoc-crossref (for table/image/section references)
+- pango-view (for PDF generation)
+
+> ![NOTE]
+> The following command doesn't work yet as the package as not been published on pypi yet.
+> Please continue with the [Development](#development) instructions for now.
+
+Run `pip install ceos-ard-cli` in the CLI to install the tool.
+
+### Execute a command
+
+After the installation you should be able to run the following command: `ceos-ard`
+
+You should see usage instructions and [available commands](#commands) for the CLI.
+
+## Commands
+
+### `ceos-ard compile`: Compile PFS document to a Markdown file
+
+To compile a PFS document to a Markdown file, run: `ceos-ard compile SR`
+
+The last part is the PFS to create, e.g. `SR` or `SAR-NRB`.
+
+Check `ceos-ard compile --help` for more details.
+
+### `ceos-ard generate`: Create Word/HTML/PDF documents for a single PFS
+
+To create the Word, HTML, and PDF versions of a single PFS, run: `ceos-ard generate SR`
+
+The last part is the PFS to create, e.g. `SR` or `SAR-NRB`.
+
+Check `ceos-ard generate --help` for more details.
+
+### `ceos-ard generate-all`: Create Word/HTML/PDF documents for all PFSes
+
+To create the Word, HTML, and PDF versions for all PFSes, run: `ceos-ard generate-all`
+
+Check `ceos-ard generate-all --help` for more details.
+
+### `ceos-ard validate`: Validate CEOS-ARD components
+
+To validate (most of) the building blocks, run: `ceos-ard validate`
+
+Check `ceos-ard validate --help` for more details.
+
+## Development
+
+1. Install the dependencies (Python, Pandoc, pandoc-crossref, pango-view) as indicated in [Installation](#installation)
+2. Fork this repository if you plan to change the code or create pull requests.
+3. Clone either your forked repository or this repository, e.g. `git clone https://github.com/ceos-org/ceos-ard-cli`
+4. Switch into the newly created folder: `cd ceos-ard-cli`
+5. Install this package in development mode: `pip install -e .`

ceos_ard_cli-0.1.0/ceos_ard_cli/__init__.py

@@ -0,0 +1,94 @@
+import click
+import sys
+
+from .compile import compile as compile_
+from .generate import generate as generate_, generate_all as generate_all_
+from .validate import validate as validate_
+from .version import __version__
+
+@click.group()
+@click.version_option(version=__version__)
+def cli():
+    """
+    The CEOS ARD CLI.
+    """
+    pass
+
+@click.command()
+@click.argument('pfs', nargs=1)
+@click.option('--output', '-o', default=None, help='Output file without file extension, defaults to the name of the given PFS')
+@click.option('--editable', '-e', is_flag=True, default=False, help="Adds an 'Assessment' section to the requirements (for editable Word documents)")
+def compile(pfs, output, editable):
+    """
+    Compiles the Markdown file for the given PFS.
+    """
+    print(f"CEOS-ARD CLI {__version__} - Compile {pfs} as Markdown\n")
+
+    if not output:
+        output = pfs
+
+    try:
+        compile_(pfs, output, editable)
+    except Exception as e:
+        print(e)
+        sys.exit(1)
+
+@click.command()
+@click.argument('pfs', nargs=1)
+@click.option('--output', '-o', default=None, help='Output file without file extension, defaults to the name of the given PFS')
+@click.option('--pdf', is_flag=True, default=True, help='Enable/disable PDF generation')
+def generate(pfs, output, pdf):
+    """
+    Generates the Word and HTML files for the given PFS.
+
+    Requires that pandoc is installed.
+    """
+    print(f"CEOS-ARD CLI {__version__} - Generate {pfs}\n")
+
+    if not output:
+        output = pfs
+
+    try:
+        generate_(pfs, output, pdf)
+    except Exception as e:
+        print(e)
+        sys.exit(1)
+
+@click.command()
+@click.option('--output', '-o', default="", help='Output folder, defaults to the current folder')
+@click.option('--pdf', is_flag=True, default=True, help='Enable/disable PDF generation')
+def generate_all(output, pdf):
+    """
+    Generates all files for all PFS.
+
+    Requires that pandoc is installed.
+    """
+    print(f"CEOS-ARD CLI {__version__} - Generate all PFS\n")
+    try:
+        errors = generate_all_(output, pdf)
+        print()
+        print(f"Done with {errors} errors")
+        sys.exit(errors)
+    except Exception as e:
+        print(e)
+        sys.exit(1)
+
+@click.command()
+def validate():
+    """
+    Validates (most of) the building blocks.
+    """
+    print(f"CEOS-ARD CLI {__version__} - Validate building blocks\n")
+    try:
+        validate_()
+    except Exception as e:
+        print(e)
+        sys.exit(1)
+
+cli.add_command(compile)
+cli.add_command(generate)
+cli.add_command(generate_all)
+cli.add_command(validate)
+
+if __name__ == '__main__':
+    cli()

ceos_ard_cli-0.1.0/ceos_ard_cli/compile.py

@@ -0,0 +1,136 @@
+import shutil
+
+from pathlib import Path
+from .utils.files import read_file, write_file
+from .utils.pfs import read_pfs
+from .utils.requirement import slugify
+from .utils.template import read_template
+from .schema import REFERENCE_PATH
+
+def unique_merge(existing, additional, key = None):
+    if key is None:
+        return list(set(existing + additional))
+    else:
+        existing_keys = [e[key] for e in existing]
+        for a in additional:
+            if a[key] not in existing_keys:
+                existing.append(a)
+        return existing
+
+def bubble_up(root):
+    return _bubble_up(root, root)
+
+def _bubble_up(data, root):
+    if isinstance(data, dict):
+        if "glossary" in data:
+            root["glossary"] = unique_merge(root["glossary"], data["glossary"], "term")
+        if "references" in data:
+            root["references"] = unique_merge(root["references"], data["references"])
+        for v in data.values():
+            _bubble_up(v, root)
+    elif isinstance(data, list):
+        for v in data:
+            _bubble_up(v, root)
+    return root
+
+def compile(pfs, out, editable = False):
+    folder = Path(out).parent
+    # create folder if needed
+    folder.mkdir(parents=True, exist_ok=True)
+    # copy assets if needed
+    assets = folder / "assets"
+    if not assets.exists():
+        shutil.copytree(Path("assets"), assets)
+    # read the PFS information
+    data = read_pfs(pfs)
+    # move the glossary and references to the top level
+    data = bubble_up(data)
+    # write a json file for debugging
+    # import json
+    # write_file(f"{out}.debug.json", json.dumps(data, indent=2))
+    # create the markfown template
+    compile_markdown(data, f"{out}.md", editable)
+    # write bibtex file to disk
+    compile_bibtex(data, f"{out}.bib")
+
+def compile_bibtex(data, out):
+    references = []
+    # Read references form disk
+    for ref in data["references"]:
+        filepath = REFERENCE_PATH.format(id=ref)
+        bibtex = read_file(filepath)
+        references.append(bibtex)
+    # Merge into a single string
+    merged_bibtex = "\n".join(references)
+    # Write a single bibtex file back to disk
+    write_file(out, merged_bibtex)
+
+# make uid unique so that it can be used in multiple categories
+def create_uid(block, req_id):
+    return slugify(block['category']['id'] + "-" + req_id)
+
+def compile_markdown(data, out, editable):
+    # create a copy of the data for the template
+    context = data.copy()
+
+    context["editable"] = editable
+    # sort glossary
+    context["glossary"] = sorted(context["glossary"], key = lambda x: x['term'].lower())
+    # todo: implement automatic creation of history based on git logs?
+    # todo: alternatively, add changelog to the individual files with a timestamp and compile it from there
+    context["history"] = "Not available yet"
+
+    # make a dict of all requirements for efficient dependency lookup
+    all_requirements = {}
+    # generate uid for each requirement and fill dependency lookups
+    for block in context["requirements"]:
+        # make a dict of the requirements in this category for efficient dependency lookup
+        local_requirements = {}
+        for req in block["requirements"]:
+            # make uid unique if it can be used in multiple categories
+            req['uid'] = create_uid(block, req['id'])
+            local_requirements[req['id']] = req['uid']
+            all_requirements[req['id']] = req['uid']
+
+    # resolve dependencies
+    for block in context["requirements"]:
+        for req in block["requirements"]:
+            for i, id in enumerate(req['dependencies']):
+                # 1. Check to the requirement in the same requirement category.
+                if id in local_requirements:
+                    ref_id = local_requirements[id]
+                # 2. Refers to the requirement in any other category.
+                elif id in all_requirements:
+                    ref_id = all_requirements[id]
+                else:
+                    raise ValueError(f"Unmet dependency {id} for requirement {req['uid']}")
+
+                req['dependencies'][i] = ref_id
+                # Update the requirements in the texts
+                update_requirement_references(req, id, ref_id)
+
+    # read, fill and write the template
+    template = read_template()
+    markdown = template.render(**context)
+    write_file(out, markdown)
+
+# replace all requirement references in the texts with the resolved references
+def update_requirement_references(req, old_id, new_id):
+    req['description'] = update_requirement_reference(req['description'], old_id, new_id)
+    if req['threshold'] is not None:
+        req['threshold']['description'] = update_requirement_reference(req['threshold']['description'], old_id, new_id)
+        req['threshold']['notes'] = update_requirement_reference(req['threshold']['notes'], old_id, new_id)
+    if req['goal'] is not None:
+        req['goal']['description'] = update_requirement_reference(req['goal']['description'], old_id, new_id)
+        req['goal']['notes'] = update_requirement_reference(req['goal']['notes'], old_id, new_id)
+
+# replace all requirement references in the given texts with the resolved references
+def update_requirement_reference(req, old_id, new_id):
+    if isinstance(req, list):
+        return [update_requirement_reference(r, old_id, new_id) for r in req]
+    elif isinstance(req, str):
+        # todo: this can probably be improved with a regex to minimmize false positives
+        print(old_id, new_id)
+        return req.replace(f"@{old_id}", f"@sec:{new_id}")
+    else:
+        return req

ceos_ard_cli-0.1.0/ceos_ard_cli/generate.py

@@ -0,0 +1,63 @@
+import subprocess
+import weasyprint
+
+from pathlib import Path
+from .compile import compile
+
+def generate_all(out, pdf = True):
+    # read all folders from the pfs folder
+    pfs_folder = Path("pfs")
+    errors = 0
+    for folder in pfs_folder.iterdir():
+        if folder.is_dir():
+            pfs = folder.stem
+            print(pfs)
+            try:
+                pfs_folder = Path(out) / pfs
+                generate(pfs, pfs_folder, pdf)
+            except Exception as e:
+                print(f"Error generating {folder}: {e}")
+                errors += 1
+
+    return errors
+
+def generate(pfs, out, pdf = True):
+    print("- Generating editable Markdown")
+    compile(pfs, out, True)
+
+    print("- Generating Word")
+    run_pandoc(out, "docx")
+
+    print("- Generating read-only Markdown")
+    compile(pfs, out, False)
+
+    print("- Generating HTML")
+    run_pandoc(out, "html")
+
+    if pdf:
+        print("- Generating PDF")
+        weasyprint.HTML(f"{out}.html").write_pdf(f"{out}.pdf")
+
+def run_pandoc(out, format):
+    cmd = [
+        "pandoc",
+        f"{out}.md", # input file
+        "-s", # standalone
+        "-o", f"{out}.{format}", # output file
+        "-t", format, # output format
+        "-F", "pandoc-crossref", # enable cross-references, must be before -C: https://lierdakil.github.io/pandoc-crossref/#citeproc-and-pandoc-crossref
+        "-C", # enable citation processing
+        f"--bibliography={out}.bib", # bibliography file
+        "-L", "templates/no-sectionnumbers.lua", # remove section numbers from reference links
+        "-L", "templates/pagebreak.lua", # page breaks
+        f"--template=templates/template.{format}", # template
+    ]
+
+    if format == "html":
+        cmd.append("--mathml") # alternative: --webtex for image rendering
+    elif format == "docx":
+        cmd.append("--reference-doc=templates/style.docx")
+    else:
+        raise ValueError(f"Unsupported format {format}")
+
+    subprocess.run(cmd)

ceos_ard_cli-0.1.0/ceos_ard_cli/schema.py

@@ -0,0 +1,74 @@
+from strictyaml import  Map, Str, Seq, UniqueSeq, EmptyList, Optional, NullNone, EmptyDict
+from .strictyaml.id_reference import IdReference
+from .strictyaml.md_reference import MdReference
+from .strictyaml.markdown import Markdown
+
+REFERENCE_PATH = "./references/{id}.bib"
+GLOSSARY_PATH = "./glossary/{id}.yaml"
+INTRODUCTION_PATH = "./sections/introduction/{id}.yaml"
+ANNEX_PATH = "./sections/annexes/{id}.yaml"
+REQUIREMENT_CATEGORY_PATH = "./sections/requirement-categories/{id}.yaml"
+REQUIREMENT_PATH = "./requirements/{id}.yaml"
+
+_REFS = lambda path, schema = None, resolve = False: EmptyList() | UniqueSeq(IdReference(path, schema, resolve))
+_RESOLVED_REFS = lambda path, schema: _REFS(path, schema, resolve = True)
+_RESOLVED_SECTIONS = lambda path: _RESOLVED_REFS(path, SECTION)
+_REFERENCE_IDS = _REFS(REFERENCE_PATH)
+
+_MARKDOWN = lambda file: Markdown() | MdReference(file) # The order is important
+
+_REQUIREMENT_PART = lambda file: NullNone() | Map({
+    'description': _MARKDOWN(file),
+    Optional('notes', default = []): EmptyList() | Seq(_MARKDOWN(file)),
+})
+
+AUTHORS = lambda file: Seq(Map({
+    'name': Str(),
+    Optional('country', default = ''): Str(),
+    'members': UniqueSeq(Str()),
+}))
+
+GLOSSARY = lambda file: Map({
+    'term': Str(),
+    'description': _MARKDOWN(file),
+})
+_RESOLVED_GLOSSARY = _RESOLVED_REFS(GLOSSARY_PATH, GLOSSARY)
+
+SECTION = lambda file: Map({
+    Optional('id', default = ""): Str(),
+    'title': Str(),
+    'description': _MARKDOWN(file),
+    Optional('glossary', default = []): _RESOLVED_GLOSSARY,
+    Optional('references', default = []): _REFERENCE_IDS,
+})
+
+PFS_DOCUMENT = lambda file: Map({
+    'id': Str(),
+    'title': Str(),
+    'type': Str(),
+    'applies_to': _MARKDOWN(file),
+    Optional('introduction', default = []): _RESOLVED_SECTIONS(INTRODUCTION_PATH),
+    Optional('glossary', default = []): _RESOLVED_GLOSSARY,
+    Optional('references', default = []): _REFERENCE_IDS,
+    Optional('annexes', default = []): _RESOLVED_SECTIONS(ANNEX_PATH),
+})
+
+REQUIREMENT = lambda file: Map({
+    'title': Str(),
+    Optional('description', default = ""): Str(),
+    'threshold': _REQUIREMENT_PART(file),
+    "goal": _REQUIREMENT_PART(file),
+    Optional('dependencies', default = []): _REFS(REQUIREMENT_PATH, REQUIREMENT),
+    Optional('glossary', default = []): _RESOLVED_GLOSSARY,
+    Optional('references', default = []): _REFERENCE_IDS,
+    Optional('metadata', default = {}): EmptyDict(), # todo: add metadata schema
+    Optional('legacy', default = None): EmptyDict() | Map({
+        'optical': NullNone() | Str(),
+        'sar': NullNone() | Str(),
+    })
+})
+
+REQUIREMENTS = lambda file: Seq(Map({
+    'category': IdReference(REQUIREMENT_CATEGORY_PATH, SECTION),
+    'requirements': UniqueSeq(IdReference(REQUIREMENT_PATH, REQUIREMENT)),
+}))

ceos_ard_cli-0.1.0/ceos_ard_cli/validate.py

@@ -0,0 +1,46 @@
+from .utils.files import get_all_files, get_all_folders, FILE_CACHE
+from .utils.pfs import read_pfs
+from .utils.template import read_template
+
+def log(id, error = None):
+    message = str(error) if error is not None else "OK"
+    print(f"- {id}: {message}")
+
+def validate():
+
+    # Validate PFS template
+    print("Validating PFS template (basic checks only)")
+    error = None
+    try:
+        # todo: check more, this check is only very high-level jinja-based
+        read_template()
+    except Exception as e:
+        error = e
+    finally:
+        log("templates/template.md", error)
+
+    # Validate all PFS
+    # This also validates all files that are used/referenced in the PFS
+    print("Validating PFS")
+    all_pfs = get_all_folders("pfs")
+    for folder in all_pfs:
+        pfs = folder.stem
+        error = None
+        try:
+            read_pfs(pfs)
+        except Exception as e:
+            error = e
+        finally:
+            log(pfs, error)
+
+    # todo: check all files, even if unused
+    print("Checking for files not referenced by any PFS (none of them gets validated)")
+    # Get a list of all files that were read during PFS validation
+    used_files = list(FILE_CACHE.keys())
+    # Get all files in the glossary, requirements, and sections
+    all_files = get_all_files(["glossary", "requirements", "sections"])
+    # Print all files that are not refernced by any PFS
+    for file in all_files:
+        filepath = str(file.absolute())
+        if filepath not in used_files:
+            print(f"- {file.relative_to(".")}")

ceos_ard_cli-0.1.0/ceos_ard_cli/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

ceos_ard_cli-0.1.0/ceos_ard_cli.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.2
+Name: ceos-ard-cli
+Version: 0.1.0
+Summary: CLI tools for CEOS-ARD
+Home-page: https://github.com/ceos-org/ceos-ard-cli
+Author: Matthias Mohr
+License: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: strictyaml>=1.7.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: weasyprint>=64.0
+Requires-Dist: bibtexparser==2.0.0b8
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+# CEOS-ARD CLI <!-- omit in toc -->
+
+CLI for working with the [CEOS-ARD building blocks and PFSes](https://github.com/ceos-org/ceos-ard).
+
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+  - [Execute a command](#execute-a-command)
+- [Commands](#commands)
+  - [`ceos-ard compile`: Compile PFS document to a Markdown file](#ceos-ard-compile-compile-pfs-document-to-a-markdown-file)
+  - [`ceos-ard generate`: Create Word/HTML/PDF documents for a single PFS](#ceos-ard-generate-create-wordhtmlpdf-documents-for-a-single-pfs)
+  - [`ceos-ard generate-all`: Create Word/HTML/PDF documents for all PFSes](#ceos-ard-generate-all-create-wordhtmlpdf-documents-for-all-pfses)
+  - [`ceos-ard validate`: Validate CEOS-ARD components](#ceos-ard-validate-validate-ceos-ard-components)
+- [Development](#development)
+
+## Getting Started
+
+In order to make working with CEOS-ARD easier we have developed command-line interface (CLI) tools.
+
+### Installation
+
+You will need to have **Python 3.9** or any later version installed.
+
+For the `generate` and `generate-all` commands you also need the following software installed:
+
+- pandoc 3.6 or later (for Word + HTML generation)
+- pandoc-crossref (for table/image/section references)
+- pango-view (for PDF generation)
+
+> ![NOTE]
+> The following command doesn't work yet as the package as not been published on pypi yet.
+> Please continue with the [Development](#development) instructions for now.
+
+Run `pip install ceos-ard-cli` in the CLI to install the tool.
+
+### Execute a command
+
+After the installation you should be able to run the following command: `ceos-ard`
+
+You should see usage instructions and [available commands](#commands) for the CLI.
+
+## Commands
+
+### `ceos-ard compile`: Compile PFS document to a Markdown file
+
+To compile a PFS document to a Markdown file, run: `ceos-ard compile SR`
+
+The last part is the PFS to create, e.g. `SR` or `SAR-NRB`.
+
+Check `ceos-ard compile --help` for more details.
+
+### `ceos-ard generate`: Create Word/HTML/PDF documents for a single PFS
+
+To create the Word, HTML, and PDF versions of a single PFS, run: `ceos-ard generate SR`
+
+The last part is the PFS to create, e.g. `SR` or `SAR-NRB`.
+
+Check `ceos-ard generate --help` for more details.
+
+### `ceos-ard generate-all`: Create Word/HTML/PDF documents for all PFSes
+
+To create the Word, HTML, and PDF versions for all PFSes, run: `ceos-ard generate-all`
+
+Check `ceos-ard generate-all --help` for more details.
+
+### `ceos-ard validate`: Validate CEOS-ARD components
+
+To validate (most of) the building blocks, run: `ceos-ard validate`
+
+Check `ceos-ard validate --help` for more details.
+
+## Development
+
+1. Install the dependencies (Python, Pandoc, pandoc-crossref, pango-view) as indicated in [Installation](#installation)
+2. Fork this repository if you plan to change the code or create pull requests.
+3. Clone either your forked repository or this repository, e.g. `git clone https://github.com/ceos-org/ceos-ard-cli`
+4. Switch into the newly created folder: `cd ceos-ard-cli`
+5. Install this package in development mode: `pip install -e .`

ceos_ard_cli-0.1.0/ceos_ard_cli.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+setup.py
+ceos_ard_cli/__init__.py
+ceos_ard_cli/compile.py
+ceos_ard_cli/generate.py
+ceos_ard_cli/schema.py
+ceos_ard_cli/validate.py
+ceos_ard_cli/version.py
+ceos_ard_cli.egg-info/PKG-INFO
+ceos_ard_cli.egg-info/SOURCES.txt
+ceos_ard_cli.egg-info/dependency_links.txt
+ceos_ard_cli.egg-info/entry_points.txt
+ceos_ard_cli.egg-info/requires.txt
+ceos_ard_cli.egg-info/top_level.txt

ceos_ard_cli-0.1.0/ceos_ard_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ceos_ard_cli-0.1.0/ceos_ard_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ceos-ard = ceos_ard_cli:cli

ceos_ard_cli-0.1.0/ceos_ard_cli.egg-info/requires.txt

@@ -0,0 +1,5 @@
+strictyaml>=1.7.0
+jinja2>=3.1.0
+click>=8.0.0
+weasyprint>=64.0
+bibtexparser==2.0.0b8

ceos_ard_cli-0.1.0/ceos_ard_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+ceos_ard_cli

ceos_ard_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ceos_ard_cli-0.1.0/setup.py

@@ -0,0 +1,44 @@
+import re
+from setuptools import setup, find_packages
+from pathlib import Path
+
+def get_version():
+    with open('ceos_ard_cli/version.py', 'r') as file:
+        content = file.read()
+        return re.match(r'__version__\s*=\s*"([^"]+)"', content)[1]
+
+def get_description():
+    this_directory = Path(__file__).parent
+    return (this_directory / "README.md").read_text()
+
+setup(
+    name="ceos-ard-cli",
+    version=get_version(),
+    license="Apache-2.0",
+    description="CLI tools for CEOS-ARD",
+    long_description=get_description(),
+    long_description_content_type="text/markdown",
+    author="Matthias Mohr",
+    url="https://github.com/ceos-org/ceos-ard-cli",
+    install_requires=[
+        "strictyaml>=1.7.0",
+        "jinja2>=3.1.0",
+        "click>=8.0.0",
+        "weasyprint>=64.0",
+        "bibtexparser==2.0.0b8"
+    ],
+    extras_require={},
+    packages=find_packages(),
+    package_data={
+        "ceos_ard_cli": []
+    },
+    entry_points={
+        "console_scripts": [
+            "ceos-ard=ceos_ard_cli:cli"
+        ]
+    },
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Programming Language :: Python :: 3',
+    ],
+)