frequenz-api-common 0.8.0__tar.gz → 0.8.2__tar.gz

{frequenz_api_common-0.8.0 → frequenz_api_common-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-api-common
-Version: 0.8.0
+Version: 0.8.2
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -19,37 +19,37 @@ Classifier: Typing :: Typed
 Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: protobuf<8,>=6.31.1
+Requires-Dist: protobuf<8,>=6.32.1
 Requires-Dist: grpcio<2,>=1.72.1
 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.6.6; 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.1.0; extra == "dev-formatting"
-Requires-Dist: isort==6.0.1; extra == "dev-formatting"
+Requires-Dist: black==25.9.0; extra == "dev-formatting"
+Requires-Dist: isort==6.1.0; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
 Requires-Dist: mike==1.1.2; extra == "dev-mkdocs"
 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-material==9.6.15; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.29.1; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[api]==0.13.5; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.21; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.16.1; extra == "dev-mypy"
+Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
 Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
-Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[api]==0.13.5; extra == "dev-noxfile"
+Requires-Dist: nox==2025.10.16; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.7; extra == "dev-pylint"
+Requires-Dist: pylint==3.3.8; extra == "dev-pylint"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
+Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.14.0; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 Dynamic: license-file

frequenz_api_common-0.8.2/RELEASE_NOTES.md

@@ -0,0 +1,5 @@
+# Frequenz Common API Release Notes
+
+## New Features
+
+A new component category for electric steam boilers has been added. The use case we're adding this for is a hybrid (gas/electric) steam boiler that may switch/blend between power sources and takes _available_ electric power into consideration.

frequenz_api_common-0.8.2/proto/frequenz/api/common/v1alpha8/gridpool/gridpool.proto

@@ -0,0 +1,22 @@
+// protolint:disable MAX_LINE_LENGTH
+// Frequenz gridpool definition.
+//
+// Copyright 2025 Frequenz Energy-as-a-Service GmbH
+//
+// Licensed under the MIT License (the "License");
+// you may not use this file except in compliance with the License.
+
+syntax = "proto3";
+
+package frequenz.api.common.v1alpha8.gridpool;
+
+
+// Gridpool contains details of a specific gridpool. 
+// A gridpool is an assigned group of microgrids for the purpose of energy trading.
+message Gridpool {
+  // A unique identifier for the gridpool.
+  uint64 id = 1;
+
+  // The name of the gridpool.
+  string name = 2;
+}

{frequenz_api_common-0.8.0 → frequenz_api_common-0.8.2}/proto/frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto

@@ -174,6 +174,13 @@ enum ElectricalComponentCategory {
   // regulation, and status.
   // Examples: Siemens Gamesa SG, Vestas V series, GE Cypress, Nordex Delta.
   ELECTRICAL_COMPONENT_CATEGORY_WIND_TURBINE = 18;
+
+  // A steam boiler.
+  //
+  // Generates steam from electricity.
+  // Hybrid steam boilers may switch/blend between electricity and gas power.
+  // Examples: Bosch ELSB4x16.
+  ELECTRICAL_COMPONENT_CATEGORY_STEAM_BOILER = 19;
 }
 
 // Enum to represent the various states that a component can be in.

frequenz_api_common-0.8.2/py/frequenz/api/common/v1alpha8/__init__.py

@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Frequenz common gRPC API and bindings for v1alpha8."""

frequenz_api_common-0.8.2/py/frequenz/api/common/v1alpha8/gridpool/__init__.py

@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Gridpool bindings for Frequenz common gRPC API."""

{frequenz_api_common-0.8.0 → frequenz_api_common-0.8.2}/py/frequenz_api_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-api-common
-Version: 0.8.0
+Version: 0.8.2
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -19,37 +19,37 @@ Classifier: Typing :: Typed
 Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: protobuf<8,>=6.31.1
+Requires-Dist: protobuf<8,>=6.32.1
 Requires-Dist: grpcio<2,>=1.72.1
 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.6.6; 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.1.0; extra == "dev-formatting"
-Requires-Dist: isort==6.0.1; extra == "dev-formatting"
+Requires-Dist: black==25.9.0; extra == "dev-formatting"
+Requires-Dist: isort==6.1.0; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
 Requires-Dist: mike==1.1.2; extra == "dev-mkdocs"
 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-material==9.6.15; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.29.1; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[api]==0.13.5; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.21; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.16.1; extra == "dev-mypy"
+Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
 Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
-Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[api]==0.13.5; extra == "dev-noxfile"
+Requires-Dist: nox==2025.10.16; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.7; extra == "dev-pylint"
+Requires-Dist: pylint==3.3.8; extra == "dev-pylint"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
+Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.14.0; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 Dynamic: license-file

{frequenz_api_common-0.8.0 → frequenz_api_common-0.8.2}/py/frequenz_api_common.egg-info/SOURCES.txt

@@ -48,6 +48,7 @@ proto/frequenz/api/common/v1alpha7/type/interval.proto
 proto/frequenz/api/common/v1alpha7/type/location.proto
 proto/frequenz/api/common/v1alpha8/grid/delivery_area.proto
 proto/frequenz/api/common/v1alpha8/grid/delivery_duration.proto
+proto/frequenz/api/common/v1alpha8/gridpool/gridpool.proto
 proto/frequenz/api/common/v1alpha8/market/energy.proto
 proto/frequenz/api/common/v1alpha8/market/power.proto
 proto/frequenz/api/common/v1alpha8/market/price.proto
@@ -89,6 +90,7 @@ py/frequenz/api/common/v1alpha7/streaming/__init__.py
 py/frequenz/api/common/v1alpha7/type/__init__.py
 py/frequenz/api/common/v1alpha8/__init__.py
 py/frequenz/api/common/v1alpha8/grid/__init__.py
+py/frequenz/api/common/v1alpha8/gridpool/__init__.py
 py/frequenz/api/common/v1alpha8/market/__init__.py
 py/frequenz/api/common/v1alpha8/metrics/__init__.py
 py/frequenz/api/common/v1alpha8/microgrid/__init__.py

{frequenz_api_common-0.8.0 → frequenz_api_common-0.8.2}/py/frequenz_api_common.egg-info/requires.txt

@@ -1,4 +1,4 @@
-protobuf<8,>=6.31.1
+protobuf<8,>=6.32.1
 grpcio<2,>=1.72.1
 
 [dev]
@@ -7,35 +7,35 @@ frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,de
 [dev-flake8]
 flake8==7.3.0
 flake8-docstrings==1.7.0
-flake8-pyproject==1.2.3
-pydoclint==0.6.6
+flake8-pyproject==1.2.4
+pydoclint==0.8.3
 pydocstyle==6.3.0
 
 [dev-formatting]
-black==25.1.0
-isort==6.0.1
+black==25.9.0
+isort==6.1.0
 
 [dev-mkdocs]
 mike==1.1.2
 mkdocs-gen-files==0.5.0
 mkdocs-literate-nav==0.6.2
-mkdocs-material==9.6.15
-mkdocstrings[python]==0.29.1
-frequenz-repo-config[api]==0.13.5
+mkdocs-material==9.6.21
+mkdocstrings[python]==0.30.1
+frequenz-repo-config[api]==0.14.0
 
 [dev-mypy]
-mypy==1.16.1
+mypy==1.18.2
 grpc-stubs==1.53.0.6
 frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-nox==2025.5.1
-frequenz-repo-config[api]==0.13.5
+nox==2025.10.16
+frequenz-repo-config[api]==0.14.0
 
 [dev-pylint]
-pylint==3.3.7
+pylint==3.3.8
 frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==8.4.1
-frequenz-repo-config[extra-lint-examples]==0.13.5
+pytest==8.4.2
+frequenz-repo-config[extra-lint-examples]==0.14.0

{frequenz_api_common-0.8.0 → frequenz_api_common-0.8.2}/pyproject.toml

@@ -4,13 +4,13 @@
 [build-system]
 requires = [
   "setuptools == 80.9.0",
-  "setuptools_scm[toml] == 8.3.1",
-  "frequenz-repo-config[api] == 0.13.5",
+  "setuptools_scm[toml] == 9.2.2",
+  "frequenz-repo-config[api] == 0.14.0",
   # We need to pin the protobuf, grpcio and  grpcio-tools dependencies to make
   # sure the code is generated using the minimum supported versions, as older
   # versions can't work with code that was generated with newer versions.
   # https://protobuf.dev/support/cross-version-runtime-guarantee/#backwards
-  "protobuf == 6.31.1",
+  "protobuf == 6.32.1",
   "grpcio-tools == 1.72.1",
   "grpcio == 1.72.1",
 ]
@@ -36,7 +36,7 @@ dependencies = [
   # We can't widen beyond the current value unless we bump the minimum
   # requirements too because of protobuf cross-version runtime guarantees:
   # https://protobuf.dev/support/cross-version-runtime-guarantee/#major
-  "protobuf >= 6.31.1, < 8", # Do not widen beyond 8!
+  "protobuf >= 6.32.1, < 8", # Do not widen beyond 8!
   # We couldn't find any document with a spec about the cross-version runtime
   # guarantee for grpcio, so unless we find one in the future, we'll assume
   # major version jumps are not compatible
@@ -52,34 +52,34 @@ email = "floss@frequenz.com"
 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.6.6",
+  "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.1.0", "isort == 6.0.1"]
+dev-formatting = ["black == 25.9.0", "isort == 6.1.0"]
 dev-mkdocs = [
   "mike == 1.1.2",
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.2",
-  "mkdocs-material == 9.6.15",
-  "mkdocstrings[python] == 0.29.1",
-  "frequenz-repo-config[api] == 0.13.5",
+  "mkdocs-material == 9.6.21",
+  "mkdocstrings[python] == 0.30.1",
+  "frequenz-repo-config[api] == 0.14.0",
 ]
 dev-mypy = [
-  "mypy == 1.16.1",
+  "mypy == 1.18.2",
   "grpc-stubs == 1.53.0.6",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
-dev-noxfile = ["nox == 2025.5.1", "frequenz-repo-config[api] == 0.13.5"]
+dev-noxfile = ["nox == 2025.10.16", "frequenz-repo-config[api] == 0.14.0"]
 dev-pylint = [
-  "pylint == 3.3.7",
+  "pylint == 3.3.8",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.4.1",
-  "frequenz-repo-config[extra-lint-examples] == 0.13.5",
+  "pytest == 8.4.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.14.0",
 ]
 dev = [
   "frequenz-api-common[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

frequenz_api_common-0.8.0/RELEASE_NOTES.md

@@ -1,35 +0,0 @@
-# Frequenz Common API Release Notes
-
-## Summary
-
-This release introduces the new `v1alpha8` version of the API, which includes several breaking changes compared to `v1alpha7`. The changes focus on improving consistency and clarity by renaming several symbols and removing unused components.
-
-## Upgrading
-
-- A new package `frequenz.api.common.v1alpha8` has been introduced, containing the following breaking changes from `v1alpha7`.
-
-- Removed:
-
-    + `electrical_components.Fuse`
-    + `InverterType.INVERTER_TYPE_WIND_TURBINE`
-
-- Renamed several symbols to increase consistency and clarity:
-
-    + `microgrid`:
-
-        * `MicrogridComponentIds` to `MicrogridElectricalComponentIds`
-        * `MicrogridComponentIDs.component_ids` to `MicrogridElectricalComponentIds.electrical_component_ids`
-
-    + `electrical_components`:
-
-        * `ElectricalComponentConnections.source_component_id` to `ElectricalComponentConnections.source_electrical_component_id`
-        * `ElectricalComponentConnections.destination_component_id` to `ElectricalComponentConnections.destination_electrical_component_id`
-        * `ElectricalComponentStateSnapshot.component_id` to `ElectricalComponentStateSnapshot.electrical_component_id`
-        * Transformer-related terms are renamed to align them with power transformers, which are more commonly used in electrical engineering:
-            * `electrical_components.VoltageTransformer` to `electrical_components.PowerTransformer`
-            * `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` to `ElectricalComponentCategorySpecificInfo.kind.power_transformer`
-            * `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER`
-
-    + `types`:
-
-        * The whole package has been renamed to `types` to avoid using reserved keywords in programming languages.

frequenz_api_common-0.8.0/py/frequenz/api/common/v1alpha8/__init__.py

@@ -1,4 +0,0 @@
-# License: MIT
-# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
-
-"""Frequenz common gRPC API and bindings for v1alpha7."""