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

{frequenz-api-common-0.6.1/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.1
+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.1 → 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.1
+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.1 → frequenz-api-common-0.6.2}/pyproject.toml

@@ -6,6 +6,13 @@ requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
   "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, < 6"]
+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]]

frequenz-api-common-0.6.1/RELEASE_NOTES.md

@@ -1,10 +0,0 @@
-# Frequenz Common API Release Notes
-
-## Summary
-
-This release adds a new component category `COMPONENT_CATEGORY_HVAC` to the API.
-
-## New Features
-
-- A new component category `COMPONENT_CATEGORY_HVAC` has been added to the API
-  to represent HVAC (Heating, Ventilation, and Air Conditioning) systems.

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

@@ -1,5 +1,5 @@
-grpcio<2,>=1.51.1
 protobuf<6,>=4.25.3
+grpcio<2,>=1.51.1
 
 [dev]
 frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]