Merge v0.18.x into v0.x.x (#209)

The v0.18.x branch is good enough to make a release, so we want to merge
it to v0.x.x to make it clear it is the default main branch now.

Fixes #55.

Author: llucax

RELEASE_NOTES.md

@@ -2,11 +2,13 @@
 
 ## Summary
 
-<!-- Here goes a general summary of what this release is about -->
+This release is a major breaking change, as we jump to the API specification version 0.17.x, which introduces big and fundamental breaking changes. This also starts using the `v1` namespace in `frequenz-api-common`, which also introduces major breaking changes. It would be very hard to detail all the API changes here, please refer to the [Microgrid API releases](https://github.com/frequenz-floss/frequenz-api-microgrid/releases) and [Common API releases](https://github.com/frequenz-floss/frequenz-api-common/releases).
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+- `MicrogridApiClient`:
+
+    * The client now follows the v0.17 API names, so most methods changed names and signatures.
 
 ## New Features
 

pyproject.toml

@@ -36,12 +36,14 @@ classifiers = [
 ]
 requires-python = ">= 3.11, < 4"
 dependencies = [
-  "frequenz-api-microgrid >= 0.15.5, < 0.16.0",
-  "frequenz-channels >= 1.0.0-rc1, < 2.0.0",
-  "frequenz-client-base >= 0.8.0, < 0.12.0",
-  "frequenz-client-common >= 0.3.2, < 0.4.0",
-  "grpcio >= 1.63.0, < 2",
-  "protobuf >= 5.26.1, < 7",
+  "frequenz-api-common >= 0.8.0, < 1.0.0",
+  "frequenz-api-microgrid >= 0.18.0, < 0.19.0",
+  "frequenz-channels >= 1.6.1, < 2.0.0",
+  "frequenz-client-base >= 0.10.0, < 0.12.0",
+  "frequenz-client-common >= 0.3.6, < 0.4.0",
+  "frequenz-core >= 1.3.0, < 2.0.0",
+  "grpcio >= 1.72.1, < 2",
+  "protobuf >= 6.31.1, < 7",
   "typing-extensions >= 4.13.0, < 5",
 ]
 dynamic = ["version"]
@@ -129,6 +131,10 @@ check-yield-types = false
 arg-type-hints-in-docstring = false
 arg-type-hints-in-signature = true
 allow-init-docstring = true
+per-file-ignores = [
+  # Ignore the max-line-length (E501) because enum values are just too long
+  "src/frequenz/client/microgrid/metrics/_metric.py:E501",
+]
 
 [tool.pylint.similarities]
 ignore-comments = ['yes']

src/frequenz/client/microgrid/__init__.py

@@ -7,39 +7,13 @@
 """
 
 
-from ._client import MicrogridApiClient
-from ._component import (
-    Component,
-    ComponentCategory,
-    ComponentMetadata,
-    ComponentMetricId,
-    ComponentType,
-    Fuse,
-    GridMetadata,
-    InverterType,
+from ._client import (
+    DEFAULT_CHANNEL_OPTIONS,
+    DEFAULT_GRPC_CALL_TIMEOUT,
+    MicrogridApiClient,
+    Validity,
 )
-from ._component_data import (
-    BatteryData,
-    ComponentData,
-    EVChargerData,
-    InverterData,
-    MeterData,
-)
-from ._component_error import (
-    BatteryError,
-    BatteryErrorCode,
-    ErrorLevel,
-    InverterError,
-    InverterErrorCode,
-)
-from ._component_states import (
-    BatteryComponentState,
-    BatteryRelayState,
-    EVChargerCableState,
-    EVChargerComponentState,
-    InverterComponentState,
-)
-from ._connection import Connection
+from ._delivery_area import DeliveryArea, EnergyMarketCodeType
 from ._exception import (
     ApiClientError,
     ClientNotConnected,
@@ -63,45 +37,27 @@
     UnrecognizedGrpcStatus,
 )
 from ._lifetime import Lifetime
-from ._metadata import Location, Metadata
+from ._location import Location
+from ._microgrid_info import MicrogridInfo, MicrogridStatus
 
 __all__ = [
     "ApiClientError",
-    "BatteryComponentState",
-    "BatteryData",
-    "BatteryError",
-    "BatteryErrorCode",
-    "BatteryRelayState",
     "ClientNotConnected",
-    "Component",
-    "ComponentCategory",
-    "ComponentData",
-    "ComponentMetadata",
-    "ComponentMetricId",
-    "ComponentType",
-    "Connection",
+    "DEFAULT_CHANNEL_OPTIONS",
+    "DEFAULT_GRPC_CALL_TIMEOUT",
     "DataLoss",
-    "EVChargerCableState",
-    "EVChargerComponentState",
-    "EVChargerData",
+    "DeliveryArea",
+    "EnergyMarketCodeType",
     "EntityAlreadyExists",
     "EntityNotFound",
-    "ErrorLevel",
-    "Fuse",
-    "GridMetadata",
     "GrpcError",
     "InternalError",
     "InvalidArgument",
-    "InverterComponentState",
-    "InverterData",
-    "InverterError",
-    "InverterErrorCode",
-    "InverterType",
     "Lifetime",
     "Location",
-    "Metadata",
-    "MeterData",
     "MicrogridApiClient",
+    "MicrogridInfo",
+    "MicrogridStatus",
     "OperationAborted",
     "OperationCancelled",
     "OperationNotImplemented",
@@ -114,4 +70,5 @@
     "ServiceUnavailable",
     "UnknownError",
     "UnrecognizedGrpcStatus",
+    "Validity",
 ]