frequenz-api-common 0.6.0__tar.gz → 0.6.2__tar.gz

{frequenz-api-common-0.6.0/py/frequenz_api_common.egg-info → frequenz-api-common-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-api-common
-Version: 0.6.0
+Version: 0.6.2
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

frequenz-api-common-0.6.2/RELEASE_NOTES.md

@@ -0,0 +1,5 @@
+# Frequenz Common API Release Notes
+
+## Bug Fixes
+
+- Fix a dependency issue by pinning the `grpcio` version and related libraries.

{frequenz-api-common-0.6.0 → frequenz-api-common-0.6.2}/proto/frequenz/api/common/v1/microgrid/components/components.proto

@@ -81,6 +81,9 @@ enum ComponentCategory {
   // Note that voltage transformers have efficiency losses, so the output power
   // is always less than the input power.
   COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER = 14;
+
+  // An HVAC (Heating, Ventilation, and Air Conditioning) system.
+  COMPONENT_CATEGORY_HVAC = 15;
 }
 
 // Metadata specific to a microgrid component.

{frequenz-api-common-0.6.0 → frequenz-api-common-0.6.2/py/frequenz_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-api-common
-Version: 0.6.0
+Version: 0.6.2
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

{frequenz-api-common-0.6.0 → frequenz-api-common-0.6.2}/py/frequenz_api_common.egg-info/requires.txt

@@ -1,5 +1,5 @@
+protobuf<6,>=4.25.3
 grpcio<2,>=1.51.1
-protobuf<5,>=4.25.3
 
 [dev]
 frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
@@ -12,30 +12,30 @@ pydoclint==0.4.1
 pydocstyle==6.3.0
 
 [dev-formatting]
-black==24.2.0
+black==24.4.2
 isort==5.13.2
 
 [dev-mkdocs]
 mike==1.1.2
 mkdocs-gen-files==0.5.0
 mkdocs-literate-nav==0.6.1
-mkdocs-material==9.5.13
-mkdocstrings[python]==0.24.1
-frequenz-repo-config[api]==0.9.1
+mkdocs-material==9.5.21
+mkdocstrings[python]==0.25.1
+frequenz-repo-config[api]==0.9.2
 
 [dev-mypy]
-mypy==1.9.0
+mypy==1.10.0
 grpc-stubs==1.53.0.5
 frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-nox==2024.3.2
-frequenz-repo-config[api]==0.9.1
+nox==2024.4.15
+frequenz-repo-config[api]==0.9.2
 
 [dev-pylint]
 pylint==3.1.0
 frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==8.1.1
-frequenz-repo-config[extra-lint-examples]==0.9.1
+pytest==8.2.0
+frequenz-repo-config[extra-lint-examples]==0.9.2

{frequenz-api-common-0.6.0 → frequenz-api-common-0.6.2}/pyproject.toml

@@ -5,7 +5,14 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[api] == 0.9.1",
+  "frequenz-repo-config[api] == 0.9.2",
+  # 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 == 4.25.3",
+  "grpcio-tools == 1.51.1",
+  "grpcio == 1.51.1",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -25,7 +32,15 @@ classifiers = [
   "Typing :: Typed",
 ]
 requires-python = ">= 3.11, < 4"
-dependencies = ["grpcio >= 1.51.1, < 2", "protobuf >= 4.25.3, < 5"]
+dependencies = [
+  # We can't widen beyond 6 because of protobuf cross-version runtime guarantees
+  # https://protobuf.dev/support/cross-version-runtime-guarantee/#major
+  "protobuf >= 4.25.3, < 6", # Do not widen beyond 6!
+  # 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
+  "grpcio >= 1.51.1, < 2", # Do not widen beyond 2!
+]
 dynamic = ["version"]
 
 [[project.authors]]
@@ -40,30 +55,30 @@ dev-flake8 = [
   "pydoclint == 0.4.1",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 24.2.0", "isort == 5.13.2"]
+dev-formatting = ["black == 24.4.2", "isort == 5.13.2"]
 dev-mkdocs = [
   "mike == 1.1.2",
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.1",
-  "mkdocs-material == 9.5.13",
-  "mkdocstrings[python] == 0.24.1",
-  "frequenz-repo-config[api] == 0.9.1",
+  "mkdocs-material == 9.5.21",
+  "mkdocstrings[python] == 0.25.1",
+  "frequenz-repo-config[api] == 0.9.2",
 ]
 dev-mypy = [
-  "mypy == 1.9.0",
+  "mypy == 1.10.0",
   "grpc-stubs == 1.53.0.5",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
-dev-noxfile = ["nox == 2024.3.2", "frequenz-repo-config[api] == 0.9.1"]
+dev-noxfile = ["nox == 2024.4.15", "frequenz-repo-config[api] == 0.9.2"]
 dev-pylint = [
   "pylint == 3.1.0",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.1.1",
-  "frequenz-repo-config[extra-lint-examples] == 0.9.1",
+  "pytest == 8.2.0",
+  "frequenz-repo-config[extra-lint-examples] == 0.9.2",
 ]
 dev = [
   "frequenz-api-common[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

frequenz-api-common-0.6.0/RELEASE_NOTES.md

@@ -1,58 +0,0 @@
-# Frequenz Common API Release Notes
-
-## Summary
-
-- Removed dependency on `googleapis-common-protos` in favor of internal
-`frequenz.api.common.v1.types.Decimal`, advising updates to dependencies for
-users previously relying on Google's types.
-- Renamed voltage and current metrics for clarity and introduced new metrics,
-including line-to-line voltages and Total Harmonic Distortion (THD) metrics,
-with updated naming conventions for simplicity and precision.
-
-## Upgrading
-
-- The dependency on `googleapis-common-protos` / `googleapis/googleapis` was
-  removed, now the built-in `frequenz.api.common.v1.types.Decimal` is used
-  internally instead. This is compatible with Google's type, but if you
-  depended indirectly on Google's submodule or python packages, you may need to
-  update your dependencies.
-
-  Nevertheless it is strongly recommended to remove the dependency on Google
-  repos and use the built-in `frequenz.api.common.v1.types.Decimal` instead if
-  your project only uses the `Decimal` type from it too.
-
-- Voltage metrics have been renamed from `METRIC_VOLTAGE_PHASE_[1|2|3]` to
-  `METRIC_VOLTAGE_PHASE_[1|2|3]_N`.
-
-- The variants in the enum `Metric` have been renumberd due to the addition of
-  line-to-line voltages.
-
-- Current metrics have been renamed:
-  `METRIC_AC_APPARENT_CURRENT` -> `METRIC_AC_CURRENT`
-  `METRIC_AC_APPARENT_CURRENT_PHASE_[1|2|3]` -> `METRIC_AC_CURRENT_PHASE_[1|2|3]`
-
-- Metrics for Total Harmonic Distortion have been un-abbreviated:
-  `METRIC_AC_THD_CURRENT` -> `METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT`
-  `METRIC_AC_THD_CURRENT_PHASE_[1|2|3]` -> `METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_[1|2|3]`
-
-- Renamed `SimpleMetricSample` to `SimpleMetricValue`, because it does not
-  contain a timestamp, so it does not represent a sample but a value.
-
-- Renamed `AggregatedMetricSample` to `AggregatedMetricValue`, because it does not
-  contain a timestamp, so it does not represent a sample but a value.
-
-- Renamed `MetricSampleVariant` to `MetricValueVariant`.
-
-- Rename `MetricSample.sample` to `MetricSample.value`.
-
-- Rename `SensorMetricSample.sample` to `SensorMetricSample.value`.
-
-## New Features
-
-- Added a `Frequenz.api.common.v1.types.Decimal` type, compatible with
-  `google.type.Decimal`.
-
-- The following new metrics have been added:
-  - `METRIC_VOLTAGE_PHASE_1_PHASE_2`
-  - `METRIC_VOLTAGE_PHASE_2_PHASE_3`
-  - `METRIC_VOLTAGE_PHASE_3_PHASE_1`