Add gridpool cli tool to print formulas

Author: cwasicki

pyproject.toml

@@ -26,12 +26,16 @@ classifiers = [
 ]
 requires-python = ">= 3.11, < 4"
 dependencies = [
+  "asyncclick >= 8.3.0.4, < 9",
   "typing-extensions >= 4.14.1, < 5",
   "frequenz-microgrid-component-graph @ git+https://github.com/shsms/frequenz-microgrid-component-graph-python.git@c4a458e06e541846de0a25142d5b821dd7934f47",
   "frequenz-client-assets @ git+https://github.com/shsms/frequenz-client-assets-python@bbf09104df24ddfac497e2a3dd66fe68cfdacd25"
 ]
 dynamic = ["version"]
 
+[project.scripts]
+gridpool-cli = "frequenz.gridpool.cli.__main__:main"
+
 [[project.authors]]
 name = "Frequenz Energy-as-a-Service GmbH"
 email = "[email protected]"

src/frequenz/gridpool/cli/__init__.py

@@ -0,0 +1 @@
+"""Package for CLI tool for gridpool functionality."""

src/frequenz/gridpool/cli/__main__.py

@@ -0,0 +1,60 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""CLI tool to generate formulas from the assets API."""
+import asyncio
+import os
+
+import asyncclick as click
+from frequenz.client.common.microgrid import MicrogridId
+
+from frequenz.gridpool import ComponentGraphGenerator
+
+
+@click.command()
+@click.argument("microgrid_id", type=int)
+@click.option(
+    "--prefix",
+    type=str,
+    default="{component}",
+    help="Prefix format for the output (Supports wildcards {microgrid_id} and {component}).",
+)
+async def print_formulas(
+    microgrid_id: int,
+    prefix: str,
+) -> None:
+    """Fetch and print component graph formulas for a microgrid."""
+    url = os.environ.get("ASSETS_API_URL")
+    key = os.environ.get("ASSETS_API_KEY")
+    secret = os.environ.get("ASSETS_API_SECRET")
+    if not url or not key or not secret:
+        raise click.ClickException(
+            "ASSETS_API_URL, ASSETS_API_KEY, ASSETS_API_SECRET must be set."
+        )
+    cgg = ComponentGraphGenerator(url, auth_key=key, sign_secret=secret)
+
+    graph = await cgg.get_component_graph(MicrogridId(microgrid_id))
+    power_formulas = {
+        "consumption": graph.consumer_formula(),
+        "generation": graph.producer_formula(),
+        "grid": graph.grid_formula(),
+        "pv": graph.pv_formula(None),
+        "battery": graph.battery_formula(None),
+        "chp": graph.chp_formula(None),
+        "ev": graph.ev_charger_formula(None),
+    }
+
+    for component, formula in power_formulas.items():
+        print(
+            prefix.format(component=component, microgrid_id=microgrid_id)
+            + f' = "{formula}"'
+        )
+
+
+async def main() -> None:
+    """Run the CLI tool."""
+    await print_formulas.main()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())