ceos-ard-cli 0.5.2__tar.gz → 0.5.4__tar.gz

{ceos_ard_cli-0.5.2 → ceos_ard_cli-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ceos-ard-cli
-Version: 0.5.2
+Version: 0.5.4
 Summary: CLI tools for CEOS-ARD to generate and validate PFS documents
 Project-URL: Homepage, https://github.com/ceos-org/ceos-ard-cli
 Project-URL: Repository, https://github.com/ceos-org/ceos-ard-cli

{ceos_ard_cli-0.5.2 → ceos_ard_cli-0.5.4}/ceos_ard_cli/__init__.py

@@ -39,13 +39,20 @@ def cli():
     default=False,
     help="Adds an 'Assessment' section to the requirements (for editable Word documents)",
 )
+@click.option(
+    "--stable",
+    "-r",
+    is_flag=True,
+    default=False,
+    help="Removes the '-draft' suffix from the version number, e.g. 0.1.0-draft becomes 0.1.0",
+)
 @click.option(
     "--debug",
     is_flag=True,
     default=False,
     help="Enables debugging mode, e.g. outputs a JSON file for debugging purposes and gives a stacktrace",
 )
-def compile(pfs, output, input_dir, editable, debug):
+def compile(pfs, output, input_dir, editable, stable, debug):
     """
     Compiles the Markdown file for the given PFS.
     """
@@ -56,7 +63,7 @@ def compile(pfs, output, input_dir, editable, debug):
         output = "-".join(pfs)
 
     try:
-        compile_(pfs, output, input_dir, editable=editable, debug=debug)
+        compile_(pfs, output, input_dir, editable=editable, stable=stable, debug=debug)
     except Exception as e:
         if debug:
             raise e
@@ -88,6 +95,13 @@ def compile(pfs, output, input_dir, editable, debug):
 )
 @click.option("--pdf", is_flag=True, default=True, help="Enable/disable PDF generation")
 @click.option("--docx", is_flag=True, default=True, help="Enable/disable Word (docx) generation")
+@click.option(
+    "--stable",
+    "-r",
+    is_flag=True,
+    default=False,
+    help="Removes the '-draft' suffix from the version number, e.g. 0.1.0-draft becomes 0.1.0",
+)
 @click.option(
     "--id",
     default=None,
@@ -108,7 +122,7 @@ def compile(pfs, output, input_dir, editable, debug):
     default=None,
     help="Overrides the PFS type of the document",
 )
-def generate(pfs, output, input_dir, self_contained, pdf, docx, id, title, version, pfs_type):
+def generate(pfs, output, input_dir, self_contained, pdf, docx, stable, id, title, version, pfs_type):
     """
     Generates the Word and HTML files for the given PFS.
 
@@ -128,7 +142,7 @@ def generate(pfs, output, input_dir, self_contained, pdf, docx, id, title, versi
     }
 
     try:
-        generate_(pfs, output, input_dir, self_contained, pdf, docx, metadata)
+        generate_(pfs, output, input_dir, self_contained, pdf, docx, stable, metadata)
     except Exception as e:
         print(e)
         sys.exit(1)
@@ -162,7 +176,14 @@ def generate(pfs, output, input_dir, self_contained, pdf, docx, id, title, versi
     multiple=True,
     help="PFS to generate, if not specified all PFS will be generated",
 )
-def generate_all(output, input_dir, self_contained, pdf, docx, pfs):
+@click.option(
+    "--stable",
+    "-r",
+    is_flag=True,
+    default=False,
+    help="Removes the '-draft' suffix from the version number, e.g. 0.1.0-draft becomes 0.1.0",
+)
+def generate_all(output, input_dir, self_contained, pdf, docx, pfs, stable):
     """
     Generates all files for all PFS.
 
@@ -171,7 +192,7 @@ def generate_all(output, input_dir, self_contained, pdf, docx, pfs):
     print(f"CEOS-ARD CLI {__version__} - Generate all PFS\n")
     pfs = list(pfs) if pfs is not None else []
     try:
-        errors = generate_all_(output, input_dir, self_contained, pdf, docx, pfs)
+        errors = generate_all_(output, input_dir, self_contained, pdf, docx, pfs, stable)
         print()
         print(f"Done with {errors} errors")
         sys.exit(errors)

{ceos_ard_cli-0.5.2 → ceos_ard_cli-0.5.4}/ceos_ard_cli/compile.py

@@ -305,6 +305,7 @@ def compile(
     out: Union[Path, str],
     input_dir: Union[Path, str],
     editable: bool = False,
+    stable: bool = False,
     metadata: dict = {},
     debug: bool = False,
 ):
@@ -333,6 +334,8 @@ def compile(
     else:
         data = multi_pfs[pfs[0]]
 
+    data["stable"] = stable
+
     if isinstance(data["authors"], list):
         # Convert list of authors to Markdown
         data["authors"] = "\n".join(map(lambda a: f"- {a}", data["authors"]))
@@ -340,8 +343,14 @@ def compile(
     # Override metadata if provided
     data["id"] = metadata.get("id") or data["id"]
     data["title"] = metadata.get("title") or data["title"]
-    data["version"] = metadata.get("version") or data["version"]
     data["type"] = metadata.get("type") or data["type"]
+    if metadata.get("version"):
+        data["version"] = metadata["version"]
+    elif not stable:
+        data["version"] = data["version"] + "-draft"
+
+    if stable:
+        out = out.parent / f"{out.stem}-v{data['version']}"
 
     # write a json file for debugging
     if debug:
@@ -354,6 +363,8 @@ def compile(
     # write bibtex file to disk
     compile_bibtex(data, f"{out}.bib", input_dir)
 
+    return out
+
 
 def compile_bibtex(data, out, input_dir: Path):
     input_dir = Path(input_dir).resolve()

{ceos_ard_cli-0.5.2 → ceos_ard_cli-0.5.4}/ceos_ard_cli/generate.py

@@ -15,6 +15,7 @@ def generate_all(
     pdf: bool = True,
     docx: bool = True,
     pfs_list: list = [],
+    stable: bool = False,
 ):
     # read all folders from the pfs folder
     input_dir = Path(input_dir).resolve()
@@ -35,6 +36,7 @@ def generate_all(
                     self_contained,
                     pdf,
                     docx,
+                    stable,
                 )
             except Exception as e:
                 print(f"Error generating {folder}: {e}")
@@ -50,6 +52,7 @@ def generate(
     self_contained: bool = True,
     pdf: bool = True,
     docx: bool = True,
+    stable: bool = False,
     metadata: dict = {},
 ):
     if isinstance(pfs, str):
@@ -60,20 +63,20 @@ def generate(
 
     if docx:
         print("- Generating editable Markdown")
-        compile(pfs, output, input_dir, editable=True, metadata=metadata)
+        target = compile(pfs, output, input_dir, editable=True, stable=stable, metadata=metadata)
 
         print("- Generating Word")
-        run_pandoc(output, "docx", input_dir, self_contained)
+        run_pandoc(target, "docx", input_dir, self_contained)
 
     print("- Generating read-only Markdown")
-    compile(pfs, output, input_dir, editable=False, metadata=metadata)
+    target = compile(pfs, output, input_dir, editable=False, stable=stable, metadata=metadata)
 
     print("- Generating HTML")
-    run_pandoc(output, "html", input_dir, self_contained)
+    run_pandoc(target, "html", input_dir, self_contained)
 
     if pdf:
         print("- Generating PDF")
-        run_playwright(output, input_dir)
+        run_playwright(target, input_dir)
 
 
 def run_playwright(out: Path, input_dir: Path):

ceos_ard_cli-0.5.4/ceos_ard_cli/version.py

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

ceos_ard_cli-0.5.2/ceos_ard_cli/version.py

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