revamp script

Author: HarshCasper

.github/workflows/docs-parity-updates.yml

@@ -110,7 +110,7 @@ jobs:
         working-directory: docs
         run: |
           ls -la
-          python3 scripts/create_data_coverage.py -i target/metrics-implementation-details -r target/metrics-raw -o target/updated_coverage -s src/data/coverage/service_display_name.json
+          python3 -m scripts.create_data_coverage -i target/metrics-implementation-details -r target/metrics-raw -o target/updated_coverage -s src/data/coverage/service_display_name.json
           # Move the resulting markdown file to the docs repo
           # cp -r target/updated_coverage/md/* content/en/references/coverage && rm -R target/updated_coverage/md/
           mv -f target/updated_coverage/data/*.json src/data/coverage

scripts/create_data_coverage.py

@@ -11,64 +11,64 @@
 import shutil
 from operator import itemgetter
 
-# placeholder for the autogenerated md files (used for each service)
-DOCS_MD = """---
-title: "{service_name_title}"
-linkTitle: "{service}"
-description: >
-  {description}
-hide_readingtime: true
----
-
-## Coverage Overview
-{{{{< localstack_coverage_table service="{service}" >}}}}
-
-## Testing Details
-{{{{< localstack_coverage_details service="{service}" >}}}}
-"""
-
-
-def create_markdown_files_for_services(
-    target_dir: str,
-    services: list[str],
-    service_lookup_details: str = None,
-    delete_if_exists: bool = False,
-):
-    """
-    Creates markdown files for each service, which in turn uses shortcodes + templates to construct the site
-    :param target_dir: directory where the md-files should be stored
-    :param services: list of services
-    :service_lookup_details: path to service_display_name.json that contains "long_name" and "short_name" for each service.
-    If set the names will be used for the description of the md. Else we use the original "service" name.
-    :param delete_if_exists: checks if the target_dir exists and deletes it before creating new md-files. default: False
-    """
-    service_lookup = Path(service_lookup_details)
-    service_info = {}
-    if service_lookup.exists() and service_lookup.is_file():
-        with open(service_lookup, "r") as f:
-            service_info = json.load(f)
-
-    for service in services:
-        dirpath = Path(target_dir).joinpath(f"coverage_{service}")
-        if delete_if_exists:
-            if dirpath.exists() and dirpath.is_dir():
-                shutil.rmtree(dirpath)
-
-        dirpath.mkdir(parents=True, exist_ok=True)
-
-        # default names in case there is no service_name_details
-        service_name_title = service
-        description = f"Implementation details for API {service}"
-
-        if service_name_details := service_info.get(service, {}):
-            service_name_title = service_name_details.get("long_name", service)
-            if service_name_title and (short_name := service_name_details.get("short_name")):
-                service_name_title = f"{short_name} ({service_name_title})"
+# # placeholder for the autogenerated md files (used for each service)
+# DOCS_MD = """---
+# title: "{service_name_title}"
+# linkTitle: "{service}"
+# description: >
+#   {description}
+# hide_readingtime: true
+# ---
+
+# ## Coverage Overview
+# {{{{< localstack_coverage_table service="{service}" >}}}}
+
+# ## Testing Details
+# {{{{< localstack_coverage_details service="{service}" >}}}}
+# """
+
+
+# def create_markdown_files_for_services(
+#     target_dir: str,
+#     services: list[str],
+#     service_lookup_details: str = None,
+#     delete_if_exists: bool = False,
+# ):
+#     """
+#     Creates markdown files for each service, which in turn uses shortcodes + templates to construct the site
+#     :param target_dir: directory where the md-files should be stored
+#     :param services: list of services
+#     :service_lookup_details: path to service_display_name.json that contains "long_name" and "short_name" for each service.
+#     If set the names will be used for the description of the md. Else we use the original "service" name.
+#     :param delete_if_exists: checks if the target_dir exists and deletes it before creating new md-files. default: False
+#     """
+#     service_lookup = Path(service_lookup_details)
+#     service_info = {}
+#     if service_lookup.exists() and service_lookup.is_file():
+#         with open(service_lookup, "r") as f:
+#             service_info = json.load(f)
+
+#     for service in services:
+#         dirpath = Path(target_dir).joinpath(f"coverage_{service}")
+#         if delete_if_exists:
+#             if dirpath.exists() and dirpath.is_dir():
+#                 shutil.rmtree(dirpath)
+
+#         dirpath.mkdir(parents=True, exist_ok=True)
+
+#         # default names in case there is no service_name_details
+#         service_name_title = service
+#         description = f"Implementation details for API {service}"
+
+#         if service_name_details := service_info.get(service, {}):
+#             service_name_title = service_name_details.get("long_name", service)
+#             if service_name_title and (short_name := service_name_details.get("short_name")):
+#                 service_name_title = f"{short_name} ({service_name_title})"
 
 
-        file_name = dirpath.joinpath("index.md")
-        with open(file_name, "w") as fd:
-            fd.write(DOCS_MD.format(service=service, description=description, service_name_title=service_name_title))
+#         file_name = dirpath.joinpath("index.md")
+#         with open(file_name, "w") as fd:
+#             fd.write(DOCS_MD.format(service=service, description=description, service_name_title=service_name_title))
 
 
 def create_data_templates_for_service(
@@ -184,12 +184,12 @@ def main(
     services = sorted(impl_details.keys())
 
     # create the coverage-docs
-    services = sorted(impl_details.keys())
-    create_markdown_files_for_services(
-        target_dir=target_dir + "/md",
-        services=services,
-        service_lookup_details=service_lookup_details,
-    )
+    # services = sorted(impl_details.keys())
+    # create_markdown_files_for_services(
+    #     target_dir=target_dir + "/md",
+    #     services=services,
+    #     service_lookup_details=service_lookup_details,
+    # )
 
     for service in services:
         # special handling for rds/neptune/docdb: the services "neptune" + "docdb" are recognized as "rds" calls