Update wiki that lists packages by category

.github/workflows/generate_package_wiki.yml

@@ -24,7 +24,7 @@ jobs:
 
       - name: Generate Wiki Content
         id: generate-content
-        run: scripts/utils/generate_package_wiki.ps1
+        run: python scripts/utils/generate_package_wiki.py
 
       - name: Commit changes
         working-directory: wiki

scripts/utils/generate_package_wiki.py

@@ -0,0 +1,88 @@
+import argparse
+import os
+import pathlib
+import xml.etree.ElementTree as ET
+from collections import defaultdict
+
+# Dict[str (category), list (packages information)]
+packages_by_category = defaultdict(str)
+
+
+def sort_write_wiki_content(file_path):
+    """ Writes package information sorted by category to a Markdown wiki file.
+
+    This function iterates through the `packages_by_category` dictionary, which
+    contains package information organized by category. For each category, it
+    generates a Markdown header and a table containing package names and
+    descriptions. The resulting Markdown content is then written to the specified
+    file.
+
+    Args:
+        file_path (str): The path to the output Markdown file.
+    """
+    wikiContent = ""
+    for category in packages_by_category.keys():
+        wikiContent += "## " + category + "\n\n"
+        wikiContent += "| Package | Description |\n"
+        wikiContent += "| ------- | ----------- |\n"
+        wikiContent += packages_by_category[category] + "\n\n"
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write(wikiContent)
+
+
+def find_element_text(parent, tag_name):
+    """Retrieves the text content of a specified XML element.
+
+    This function searches for a child element with the given tag name within the
+    provided parent element. It handles XML namespaces by using a wildcard.
+
+    Args:
+        parent: The parent XML element.
+        tag_name: The name of the child element to find.
+
+    Returns:
+        The text content of the found element, or None if the element is not found.
+    """
+    tag = parent.find(f"{{*}}{tag_name}")
+    if tag is None:
+        return None
+    return tag.text
+
+
+def process_packages_directory(packages_dir):
+    """ Obtains the package name, description and category from a directory
+
+    This function parses all the nuspec files in the specified packages directory.
+    It saves into packages_by_category[category] a line containing the package
+    name and the description separated by "|".
+
+    Args:
+        packages: directory where the packages reside.
+    """
+    if not os.path.isdir(packages_dir):
+        raise FileNotFoundError(f"Packages directory not found: {packages_dir}")
+
+    for nuspec_path in pathlib.Path(packages_dir).glob("**/*.nuspec"):
+        nuspec_tree = ET.parse(nuspec_path)
+        nuspec_metadata = nuspec_tree.find("{*}metadata")
+        if nuspec_metadata is not None:
+            category = find_element_text(nuspec_metadata, "tags")
+            # We are only interested in the packages with a category.
+            # Some packages that assist with the istallation (such as common.vm) do
+            # not contain a category
+            if not category:
+                continue
+            description = find_element_text(nuspec_metadata, "description")
+            package = find_element_text(nuspec_metadata, "id")
+            """packages_by_category is a dictionary of str where each package and description
+            are appended formatted in Markdown"""
+            packages_by_category[category] += "| " + package + " | " + description + " |\n"
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Create wiki of packages.")
+    parser.add_argument("--packages", type=str, required=False, default="packages", help="Path to packages")
+    parser.add_argument("--wiki", type=str, required=False, default="wiki/Packages.md", help="Path to the wiki")
+    args = parser.parse_args()
+    process_packages_directory(args.packages)
+    sort_write_wiki_content(args.wiki)