frequenz-gridpool 0.1.0__tar.gz → 0.2.0__tar.gz

{frequenz_gridpool-0.1.0/src/frequenz_gridpool.egg-info → frequenz_gridpool-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-gridpool
-Version: 0.1.0
+Version: 0.2.0
 Summary: High-level interface to grid pools for the Frequenz platform.
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -21,18 +21,19 @@ Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: marshmallow-dataclass<9,>=8.7.1
+Requires-Dist: asyncclick<9,>=8.3.0.4
 Requires-Dist: typing-extensions<5,>=4.14.1
 Requires-Dist: frequenz-microgrid-component-graph<0.3,>=0.2.0
 Requires-Dist: frequenz-client-assets<0.3,>=0.2.0
 Provides-Extra: dev-flake8
 Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
 Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
-Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
-Requires-Dist: pydoclint==0.8.1; extra == "dev-flake8"
+Requires-Dist: flake8-pyproject==1.2.4; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
 Requires-Dist: black==25.11.0; extra == "dev-formatting"
-Requires-Dist: isort==6.0.0; extra == "dev-formatting"
+Requires-Dist: isort==7.0.0; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
 Requires-Dist: Markdown==3.10; extra == "dev-mkdocs"
 Requires-Dist: black==25.11.0; extra == "dev-mkdocs"
@@ -41,22 +42,22 @@ Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-material==9.7.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==1.0.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocstrings-python==1.19.0; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.7; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: mypy==1.19.0; extra == "dev-mypy"
 Requires-Dist: types-Markdown==3.10.0.20251106; extra == "dev-mypy"
 Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
 Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.7; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
 Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
 Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
-Requires-Dist: pylint==4.0.3; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.6; extra == "dev-pytest"
+Requires-Dist: pylint==4.0.4; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.7; extra == "dev-pytest"
 Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
 Requires-Dist: pytest-asyncio==1.3.0; extra == "dev-pytest"
 Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"

{frequenz_gridpool-0.1.0 → frequenz_gridpool-0.2.0}/RELEASE_NOTES.md

@@ -5,14 +5,14 @@
 <!-- Here goes a general summary of what this release is about -->
 
 ## Upgrading
-
+* Microgrid_config is updated from AC_ACTIVE_POWER to AC_POWER_ACTIVE in accordance with the update in client-reporting - v0.20.0
 <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
 
 ## New Features
 
-* Expose microgrid config `Metadata`.
+* Add CLI tool to print formulas from assets API component graph.
 
-* This introduces the `ComponentGraphGenerator`, that uses the assets API to fetch assets for a specified microgrid, and builds a component graph for it, from which various formulas for the microgrid can be generated.
+<!-- Here goes the main new features and examples or instructions on how to use them -->
 
 ## Bug Fixes
 

{frequenz_gridpool-0.1.0 → frequenz_gridpool-0.2.0}/pyproject.toml

@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 80.9.0",
   "setuptools_scm[toml] == 9.2.2",
-  "frequenz-repo-config[lib] == 0.13.6",
+  "frequenz-repo-config[lib] == 0.13.7",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -15,7 +15,6 @@ description = "High-level interface to grid pools for the Frequenz platform."
 readme = "README.md"
 license = { text = "MIT" }
 keywords = ["frequenz", "python", "lib", "library", "gridpool"]
-# TODO(cookiecutter): Remove and add more classifiers if appropriate
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
@@ -26,29 +25,31 @@ classifiers = [
   "Typing :: Typed",
 ]
 requires-python = ">= 3.11, < 4"
-# TODO(cookiecutter): Remove and add more dependencies if appropriate
 dependencies = [
-  "marshmallow-dataclass>=8.7.1,<9",
+  "marshmallow-dataclass >= 8.7.1, < 9",
+  "asyncclick >= 8.3.0.4, < 9",
   "typing-extensions >= 4.14.1, < 5",
   "frequenz-microgrid-component-graph >= 0.2.0, < 0.3",
   "frequenz-client-assets >= 0.2.0, < 0.3",
 ]
 dynamic = ["version"]
 
+[project.scripts]
+gridpool-cli = "frequenz.gridpool.cli.__main__:main"
+
 [[project.authors]]
 name = "Frequenz Energy-as-a-Service GmbH"
 email = "floss@frequenz.com"
 
-# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
 [project.optional-dependencies]
 dev-flake8 = [
   "flake8 == 7.3.0",
   "flake8-docstrings == 1.7.0",
-  "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
-  "pydoclint == 0.8.1",
+  "flake8-pyproject == 1.2.4",  # For reading the flake8 config from pyproject.toml
+  "pydoclint == 0.8.3",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 25.11.0", "isort == 6.0.0"]
+dev-formatting = ["black == 25.11.0", "isort == 7.0.0"]
 dev-mkdocs = [
   "Markdown == 3.10",
   "black == 25.11.0",
@@ -57,19 +58,19 @@ dev-mkdocs = [
   "mkdocs-literate-nav == 0.6.2",
   "mkdocs-macros-plugin == 1.5.0",
   "mkdocs-material == 9.7.0",
-  "mkdocstrings[python] == 0.30.1",
+  "mkdocstrings[python] == 1.0.0",
   "mkdocstrings-python == 1.19.0",
-  "frequenz-repo-config[lib] == 0.13.6",
+  "frequenz-repo-config[lib] == 0.13.7",
 ]
 dev-mypy = [
-  "mypy == 1.18.2",
+  "mypy == 1.19.0",
   "types-Markdown == 3.10.0.20251106",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = [
   "nox == 2025.11.12",
-  "frequenz-repo-config[lib] == 0.13.6",
+  "frequenz-repo-config[lib] == 0.13.7",
 ]
 dev-pylint = [
   # dev-pytest already defines a dependency to pylint because of the examples
@@ -78,8 +79,8 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 8.4.1",
-  "pylint == 4.0.3",       # We need this to check for the examples
-  "frequenz-repo-config[extra-lint-examples] == 0.13.6",
+  "pylint == 4.0.4",       # We need this to check for the examples
+  "frequenz-repo-config[extra-lint-examples] == 0.13.7",
   "pytest-mock == 3.15.1",
   "pytest-asyncio == 1.3.0",
   "async-solipsism == 0.8",

{frequenz_gridpool-0.1.0 → frequenz_gridpool-0.2.0}/src/frequenz/gridpool/_microgrid_config.py

@@ -41,8 +41,8 @@ class ComponentTypeConfig:
     def __post_init__(self) -> None:
         """Set the default formula if none is provided."""
         self.formula = self.formula or {}
-        if "AC_ACTIVE_POWER" not in self.formula:
-            self.formula["AC_ACTIVE_POWER"] = "+".join(
+        if "AC_POWER_ACTIVE" not in self.formula:
+            self.formula["AC_POWER_ACTIVE"] = "+".join(
                 [f"#{cid}" for cid in self._default_cids()]
             )
 

frequenz_gridpool-0.2.0/src/frequenz/gridpool/cli/__init__.py

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

frequenz_gridpool-0.2.0/src/frequenz/gridpool/cli/__main__.py

@@ -0,0 +1,72 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""CLI tool for gridpool functionality."""
+
+import os
+
+import asyncclick as click
+from frequenz.client.assets import AssetsApiClient
+from frequenz.client.common.microgrid import MicrogridId
+
+from frequenz.gridpool import ComponentGraphGenerator
+
+
+@click.group()
+async def cli() -> None:
+    """CLI tool for gridpool functionality."""
+
+
+@cli.command()
+@click.argument("microgrid_id", type=int)
+@click.option(
+    "--prefix",
+    type=str,
+    default="{component}",
+    help="Prefix format for the output (Supports {microgrid_id} and {component} placeholders).",
+)
+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_AUTH_KEY")
+    secret = os.environ.get("ASSETS_API_SIGN_SECRET")
+    if not url or not key or not secret:
+        raise click.ClickException(
+            "ASSETS_API_URL, ASSETS_API_AUTH_KEY, ASSETS_API_SIGN_SECRET must be set."
+        )
+
+    async with AssetsApiClient(
+        url,
+        auth_key=key,
+        sign_secret=secret,
+    ) as client:
+        cgg = ComponentGraphGenerator(client)
+
+        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}"'
+            )
+
+
+def main() -> None:
+    """Run the CLI tool."""
+    cli(_anyio_backend="asyncio")
+
+
+if __name__ == "__main__":
+    main()

{frequenz_gridpool-0.1.0 → frequenz_gridpool-0.2.0/src/frequenz_gridpool.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-gridpool
-Version: 0.1.0
+Version: 0.2.0
 Summary: High-level interface to grid pools for the Frequenz platform.
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -21,18 +21,19 @@ Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: marshmallow-dataclass<9,>=8.7.1
+Requires-Dist: asyncclick<9,>=8.3.0.4
 Requires-Dist: typing-extensions<5,>=4.14.1
 Requires-Dist: frequenz-microgrid-component-graph<0.3,>=0.2.0
 Requires-Dist: frequenz-client-assets<0.3,>=0.2.0
 Provides-Extra: dev-flake8
 Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
 Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
-Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
-Requires-Dist: pydoclint==0.8.1; extra == "dev-flake8"
+Requires-Dist: flake8-pyproject==1.2.4; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
 Requires-Dist: black==25.11.0; extra == "dev-formatting"
-Requires-Dist: isort==6.0.0; extra == "dev-formatting"
+Requires-Dist: isort==7.0.0; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
 Requires-Dist: Markdown==3.10; extra == "dev-mkdocs"
 Requires-Dist: black==25.11.0; extra == "dev-mkdocs"
@@ -41,22 +42,22 @@ Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-material==9.7.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==1.0.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocstrings-python==1.19.0; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.7; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: mypy==1.19.0; extra == "dev-mypy"
 Requires-Dist: types-Markdown==3.10.0.20251106; extra == "dev-mypy"
 Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
 Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.7; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
 Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
 Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
-Requires-Dist: pylint==4.0.3; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.6; extra == "dev-pytest"
+Requires-Dist: pylint==4.0.4; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.7; extra == "dev-pytest"
 Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
 Requires-Dist: pytest-asyncio==1.3.0; extra == "dev-pytest"
 Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"

{frequenz_gridpool-0.1.0 → frequenz_gridpool-0.2.0}/src/frequenz_gridpool.egg-info/SOURCES.txt

@@ -8,8 +8,11 @@ src/frequenz/gridpool/_graph_generator.py
 src/frequenz/gridpool/_microgrid_config.py
 src/frequenz/gridpool/conftest.py
 src/frequenz/gridpool/py.typed
+src/frequenz/gridpool/cli/__init__.py
+src/frequenz/gridpool/cli/__main__.py
 src/frequenz_gridpool.egg-info/PKG-INFO
 src/frequenz_gridpool.egg-info/SOURCES.txt
 src/frequenz_gridpool.egg-info/dependency_links.txt
+src/frequenz_gridpool.egg-info/entry_points.txt
 src/frequenz_gridpool.egg-info/requires.txt
 src/frequenz_gridpool.egg-info/top_level.txt

frequenz_gridpool-0.2.0/src/frequenz_gridpool.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gridpool-cli = frequenz.gridpool.cli.__main__:main

{frequenz_gridpool-0.1.0 → frequenz_gridpool-0.2.0}/src/frequenz_gridpool.egg-info/requires.txt

@@ -1,4 +1,5 @@
 marshmallow-dataclass<9,>=8.7.1
+asyncclick<9,>=8.3.0.4
 typing-extensions<5,>=4.14.1
 frequenz-microgrid-component-graph<0.3,>=0.2.0
 frequenz-client-assets<0.3,>=0.2.0
@@ -9,13 +10,13 @@ frequenz-gridpool[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-
 [dev-flake8]
 flake8==7.3.0
 flake8-docstrings==1.7.0
-flake8-pyproject==1.2.3
-pydoclint==0.8.1
+flake8-pyproject==1.2.4
+pydoclint==0.8.3
 pydocstyle==6.3.0
 
 [dev-formatting]
 black==25.11.0
-isort==6.0.0
+isort==7.0.0
 
 [dev-mkdocs]
 Markdown==3.10
@@ -25,26 +26,26 @@ mkdocs-gen-files==0.5.0
 mkdocs-literate-nav==0.6.2
 mkdocs-macros-plugin==1.5.0
 mkdocs-material==9.7.0
-mkdocstrings[python]==0.30.1
+mkdocstrings[python]==1.0.0
 mkdocstrings-python==1.19.0
-frequenz-repo-config[lib]==0.13.6
+frequenz-repo-config[lib]==0.13.7
 
 [dev-mypy]
-mypy==1.18.2
+mypy==1.19.0
 types-Markdown==3.10.0.20251106
 frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
 nox==2025.11.12
-frequenz-repo-config[lib]==0.13.6
+frequenz-repo-config[lib]==0.13.7
 
 [dev-pylint]
 frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
 pytest==8.4.1
-pylint==4.0.3
-frequenz-repo-config[extra-lint-examples]==0.13.6
+pylint==4.0.4
+frequenz-repo-config[extra-lint-examples]==0.13.7
 pytest-mock==3.15.1
 pytest-asyncio==1.3.0
 async-solipsism==0.8