Preparations for release (#165)

Author: Marenz

README.md

@@ -23,12 +23,12 @@ pip install frequenz-client-dispatch
 Here's a quick example to get you started:
 
 ```python
-from frequenz.client.dispatch import Client
+from frequenz.client.dispatch import DispatchApiClient
 import asyncio
 
 async def print_dispatches():
     # Initialize the client
-    client = Client(key="your_api_key", server_url="grpc://fz-0004.frequenz.io")
+    client = DispatchApiClient(key="your_api_key", server_url="grpc://dispatch.eu-1.prod.api.frequenz.com:443")
 
     # List all dispatches for a specific microgrid
     async for page in client.list(microgrid_id=1):
@@ -39,7 +39,7 @@ async def print_dispatches():
 asyncio.run(print_dispatches())
 ```
 
-For detailed usage and advanced features, check out the [client documentation](https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.Client).
+For detailed usage and advanced features, check out the [client documentation](https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.ApiDispatchClient).
 
 ## 🌐 Supported Platforms
 

RELEASE_NOTES.md

@@ -6,7 +6,7 @@
 
 ## Bug Fixes
 
-* `end_time` was not correctly handling the `None` value when converted from protobuf to pythons `Dispatch` class.
+* Fix that a user might see invalid values for dispatches without `end_time`. It was not correctly handling the `None` value when converted from protobuf to pythons `Dispatch` class.
 
 ## Upgrading
 

src/frequenz/client/dispatch/__main__.py

@@ -29,7 +29,7 @@
 from .recurrence import EndCriteria, Frequency, RecurrenceRule, Weekday
 from .types import Dispatch, DispatchEvent
 
-DEFAULT_DISPATCH_API_URL = "grpc://fz-0004.frequenz.io:50051"
+DEFAULT_DISPATCH_API_URL = "grpc://dispatch.eu-1.prod.api.frequenz.com:443"
 
 
 def format_datetime(dt: datetime | None) -> str:

src/frequenz/client/dispatch/_client.py

@@ -5,8 +5,6 @@
 from __future__ import annotations
 
 from datetime import datetime, timedelta
-from importlib.resources import files
-from pathlib import Path
 from typing import Any, AsyncIterator, Awaitable, Iterator, Literal, cast
 
 # pylint: disable=no-name-in-module
@@ -49,7 +47,7 @@
 )
 
 # pylint: enable=no-name-in-module
-DEFAULT_DISPATCH_PORT = 50051
+DEFAULT_DISPATCH_PORT = 443
 
 
 class DispatchApiClient(BaseApiClient[dispatch_pb2_grpc.MicrogridDispatchServiceStub]):
@@ -75,14 +73,7 @@ def __init__(
             connect=connect,
             channel_defaults=ChannelOptions(
                 port=DEFAULT_DISPATCH_PORT,
-                ssl=SslOptions(
-                    enabled=True,
-                    root_certificates=Path(
-                        str(
-                            files("frequenz.client.dispatch").joinpath("certs/root.crt")
-                        ),
-                    ),
-                ),
+                ssl=SslOptions(enabled=True),
             ),
         )
         self._metadata = (("key", key),)
@@ -125,7 +116,10 @@ async def list(
         Example usage:
 
         ```python
-        client = DispatchApiClient(key="key", server_url="grpc://fz-0004.frequenz.io")
+        client = DispatchApiClient(
+            key="key",
+            server_url="grpc://dispatch.eu-1.prod.api.frequenz.com:443"
+        )
         async for page in client.list(microgrid_id=1):
             for dispatch in page:
                 print(dispatch)
@@ -207,7 +201,10 @@ def stream(self, microgrid_id: int) -> channels.Receiver[DispatchEvent]:
         Example usage:
 
         ```
-        client = DispatchApiClient(key="key", server_url="grpc://fz-0004.frequenz.io")
+        client = DispatchApiClient(
+            key="key",
+            server_url="grpc://dispatch.eu-1.prod.api.frequenz.com:443"
+        )
         async for message in client.stream(microgrid_id=1):
             print(message.event, message.dispatch)
         ```