Add option to request public orders to CLI tool (#154)

Public orders can now be retrieved similar to the existing option for
receiving public trades.

Author: cwasicki

RELEASE_NOTES.md

@@ -2,14 +2,9 @@
 
 ## Upgrading
 
-- The minimum allowed version of `protobuf` and `grpcio` has been updated to 6.31.1 and 1.72.1 respectively.
-
 ## New Features
 
-- Updated to `v0.8.0` of the Electricity Trading API.
-- Updated to `v0.11.0` of the base client library.
 - Added HMAC capabilities
+- Add option to request public order data from the API.
 
 ## Bug Fixes
-
-- Added `OrderType` field to `PublicOrder` class.

src/frequenz/client/electricity_trading/cli/__main__.py

@@ -22,6 +22,9 @@
 from frequenz.client.electricity_trading.cli.etrading import (
     list_gridpool_trades as run_list_gridpool_trades,
 )
+from frequenz.client.electricity_trading.cli.etrading import (
+    receive_public_orders as run_receive_public_orders,
+)
 from frequenz.client.electricity_trading.cli.etrading import (
     receive_public_trades as run_receive_public_trades,
 )
@@ -73,6 +76,35 @@ def receive_public_trades(  # pylint: disable=too-many-arguments
     )
 
 
+@cli.command()
+@click.option("--url", required=True, type=str)
+@click.option("--auth_key", required=True, type=str)
+@click.option("--delivery-start", default=None, type=iso)
+@click.option("--start", default=None, type=iso)
+@click.option("--end", default=None, type=iso)
+@click.option("--sign_secret", default=None, type=str)
+def receive_public_orders(  # pylint: disable=too-many-arguments
+    url: str,
+    auth_key: str,
+    *,
+    start: datetime,
+    end: datetime,
+    delivery_start: datetime,
+    sign_secret: str | None = None,
+) -> None:
+    """List and/or stream public trades."""
+    asyncio.run(
+        run_receive_public_orders(
+            url=url,
+            auth_key=auth_key,
+            delivery_start=delivery_start,
+            start=start,
+            end=end,
+            sign_secret=sign_secret,
+        )
+    )
+
+
 @cli.command()
 @click.option("--url", required=True, type=str)
 @click.option("--auth_key", required=True, type=str)

src/frequenz/client/electricity_trading/cli/etrading.py

@@ -20,6 +20,7 @@
     OrderType,
     Power,
     Price,
+    PublicOrder,
     PublicTrade,
     Trade,
 )
@@ -81,6 +82,47 @@ async def receive_public_trades(  # pylint: disable=too-many-arguments
         print_public_trade(trade)
 
 
+async def receive_public_orders(  # pylint: disable=too-many-arguments
+    url: str,
+    auth_key: str,
+    *,
+    delivery_start: datetime | None = None,
+    start: datetime | None = None,
+    end: datetime | None = None,
+    sign_secret: str | None = None,
+) -> None:
+    """List trades and stream new public trades.
+
+    Args:
+        url: URL of the trading API.
+        auth_key: API key.
+        delivery_start: Start of the delivery period or None.
+        start: First execution time to list trades from.
+        end: Last execution time to list trades until.
+        sign_secret: The cryptographic secret to use for HMAC generation.
+    """
+    client = Client(server_url=url, auth_key=auth_key, sign_secret=sign_secret)
+
+    print_public_orders_header()
+
+    delivery_period = None
+    # If delivery period is selected, list historical trades also
+    if delivery_start is not None:
+        check_delivery_start(delivery_start)
+        delivery_period = DeliveryPeriod(
+            start=delivery_start,
+            duration=timedelta(minutes=15),
+        )
+    stream = client.receive_public_order_book(
+        delivery_period=delivery_period,
+        start_time=start,
+        end_time=end,
+    )
+    async for orders in stream.new_receiver():
+        for order in orders:
+            print_public_order(order)
+
+
 async def list_gridpool_trades(
     url: str,
     auth_key: str,
@@ -301,6 +343,44 @@ def print_public_trade(trade: PublicTrade) -> None:
     print(",".join(v.name if isinstance(v, Enum) else str(v) for v in values))
 
 
+def print_public_orders_header() -> None:
+    """Print public order header in CSV format."""
+    header = (
+        "public_order_id,"
+        "create_time,"
+        "update_time,"
+        "delivery_period_start,"
+        "delivery_period_duration,"
+        "delivery_area_code,"
+        "quantity_mw,"
+        "side,"
+        "price_amount,"
+        "price_currency,"
+        "type,"
+        "execution_option"
+    )
+    print(header)
+
+
+def print_public_order(order: PublicOrder) -> None:
+    """Print public order details to stdout in CSV format."""
+    values = (
+        order.public_order_id,
+        order.create_time.isoformat(),
+        order.update_time.isoformat(),
+        order.delivery_period.start.isoformat(),
+        order.delivery_period.duration,
+        order.delivery_area.code,
+        order.quantity.mw,
+        order.side,
+        order.price.amount,
+        order.price.currency,
+        order.type,
+        order.execution_option,
+    )
+    print(",".join(v.name if isinstance(v, Enum) else str(v) for v in values))
+
+
 def print_trade_header() -> None:
     """Print trade header in CSV format."""
     header = (