docs: update release notes for v0.4.0 API features

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

RELEASE_NOTES.md

@@ -7,7 +7,12 @@ Initial release of the Frequenz Market Metering API client for Python.
 ## New Features
 
 - `MarketMeteringApiClient`: Main client class for connecting to the Market Metering service
-- `stream_samples()`: Async iterator for streaming metering samples from Market Locations
+- `upsert_samples()`: Bidirectional streaming for upserting metering samples.
+- `create_market_location()`: Create a new Market Location.
+- `update_market_location()`: Update an existing Market Location.
+- `activate_market_location()`: Activate a Market Location.
+- `deactivate_market_location()`: Deactivate a Market Location.
+- `list_market_locations()`: List Market Locations with filtering and pagination.
 - `stream()`: Channel-based receiver for streaming with automatic reconnection
 - CLI tool (`marketmetering-cli`) for quick access to metering data
 - Support for multiple market identifier types:

mkdocs.yml

@@ -102,9 +102,9 @@ plugins:
   - mkdocstrings:
       default_handler: python
       handlers:
-        paths: ["src"]
         python:
           options:
+            paths: ["src"]
             docstring_section_style: spacy
             inherited_members: true
             merge_init_into_class: false
@@ -116,7 +116,7 @@ plugins:
             show_source: true
             show_symbol_type_toc: true
             signature_crossrefs: true
-          inventories:
+          import:
             # TODO(cookiecutter): You might want to add other external references here
             # See https://mkdocstrings.github.io/python/usage/#import for details
             - https://docs.python.org/3/objects.inv

src/frequenz/client/marketmetering/_client.py

@@ -25,6 +25,7 @@
     MarketLocation,
     MarketLocationEntry,
     MarketLocationRef,
+    MarketLocationSample,
     MarketLocationSeries,
     MarketLocationsFilter,
     MarketLocationUpdate,
@@ -34,7 +35,6 @@
     ResamplingOptions,
     RevisionSelection,
     UpsertResult,
-    MarketLocationSample,
 )
 
 DEFAULT_PORT = 443
@@ -311,9 +311,9 @@ async def upsert_samples(
             UpsertResult objects indicating success or failure for each sample.
         """
 
-        async def request_generator() -> AsyncIterator[
-            pb.UpsertMarketLocationSamplesStreamRequest
-        ]:
+        async def request_generator() -> (
+            AsyncIterator[pb.UpsertMarketLocationSamplesStreamRequest]
+        ):
             async for ml_ref, series in samples_stream:
                 for sample in series.samples:
                     yield pb.UpsertMarketLocationSamplesStreamRequest(

src/frequenz/client/marketmetering/types.py

@@ -12,8 +12,7 @@
     pagination_params_pb2 as pagination_params_pb,
 )
 from frequenz.api.marketmetering.v1alpha1 import marketmetering_pb2 as pb
-from google.protobuf import struct_pb2
-from google.protobuf import field_mask_pb2
+from google.protobuf import field_mask_pb2, struct_pb2
 from google.protobuf.timestamp_pb2 import Timestamp
 
 
@@ -691,11 +690,13 @@ def from_protobuf(
             # Here we assume it's always present or defaults to 0.
             revision=pb_obj.revision,
             update_time=update_time,
-            resampling_method=ResamplingMethod(pb_obj.resampling_method)
-            if isinstance(pb_obj, pb.MarketLocationSampleDetail)
-            # Fallback to UNSPECIFIED if it's a simple MarketLocationSample
-            # which does not have this field.
-            else ResamplingMethod.UNSPECIFIED,
+            resampling_method=(
+                ResamplingMethod(pb_obj.resampling_method)
+                if isinstance(pb_obj, pb.MarketLocationSampleDetail)
+                # Fallback to UNSPECIFIED if it's a simple MarketLocationSample
+                # which does not have this field.
+                else ResamplingMethod.UNSPECIFIED
+            ),
         )
 
     def to_protobuf(self) -> pb.MarketLocationSample: