diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index ae6e26bb..c0bb8760 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -6,14 +6,14 @@ ## Upgrading - +* Rename CLI trade and order functions for clarity + * Rename `receive_trades` to `receive_public_trades` + * Rename `receive_orders` to `receive_gridpool_orders` ## New Features * Print tags and filled (instead of open) quantity for gridpool orders in CLI tool. - - ## Bug Fixes diff --git a/src/frequenz/client/electricity_trading/cli/__main__.py b/src/frequenz/client/electricity_trading/cli/__main__.py index 075a094c..65cb8935 100644 --- a/src/frequenz/client/electricity_trading/cli/__main__.py +++ b/src/frequenz/client/electricity_trading/cli/__main__.py @@ -17,13 +17,13 @@ create_order as run_create_order, ) from frequenz.client.electricity_trading.cli.etrading import ( - list_gridpool_trades as run_list_gridpool_trades, + list_gridpool_orders as run_list_gridpool_orders, ) from frequenz.client.electricity_trading.cli.etrading import ( - list_orders as run_list_orders, + list_gridpool_trades as run_list_gridpool_trades, ) from frequenz.client.electricity_trading.cli.etrading import ( - list_trades as run_list_trades, + list_public_trades as run_list_public_trades, ) TZ = ZoneInfo("Europe/Berlin") @@ -48,9 +48,9 @@ def cli() -> None: @click.option("--url", required=True, type=str) @click.option("--key", required=True, type=str) @click.option("--start", default=None, type=iso) -def receive_trades(url: str, key: str, *, start: datetime) -> None: - """List and/or stream trades.""" - asyncio.run(run_list_trades(url=url, key=key, delivery_start=start)) +def receive_public_trades(url: str, key: str, *, start: datetime) -> None: + """List and/or stream public trades.""" + asyncio.run(run_list_public_trades(url=url, key=key, delivery_start=start)) @cli.command() @@ -59,7 +59,7 @@ def receive_trades(url: str, key: str, *, start: datetime) -> None: @click.option("--gid", required=True, type=int) @click.option("--start", default=None, type=iso) def receive_gridpool_trades(url: str, key: str, gid: int, *, start: datetime) -> None: - """List and/or stream orders.""" + """List and/or stream gridpool trades.""" asyncio.run( run_list_gridpool_trades(url=url, key=key, gid=gid, delivery_start=start) ) @@ -70,9 +70,11 @@ def receive_gridpool_trades(url: str, key: str, gid: int, *, start: datetime) -> @click.option("--key", required=True, type=str) @click.option("--start", default=None, type=iso) @click.option("--gid", required=True, type=int) -def receive_orders(url: str, key: str, *, start: datetime, gid: int) -> None: - """List and/or stream orders.""" - asyncio.run(run_list_orders(url=url, key=key, delivery_start=start, gid=gid)) +def receive_gridpool_orders(url: str, key: str, *, start: datetime, gid: int) -> None: + """List and/or stream gridpool orders.""" + asyncio.run( + run_list_gridpool_orders(url=url, key=key, delivery_start=start, gid=gid) + ) @cli.command() diff --git a/src/frequenz/client/electricity_trading/cli/etrading.py b/src/frequenz/client/electricity_trading/cli/etrading.py index 99e5f61b..ba85c09b 100644 --- a/src/frequenz/client/electricity_trading/cli/etrading.py +++ b/src/frequenz/client/electricity_trading/cli/etrading.py @@ -41,8 +41,8 @@ def check_delivery_start( raise ValueError("Delivery period must be a multiple of `duration`.") -async def list_trades(url: str, key: str, *, delivery_start: datetime) -> None: - """List trades and stream new trades. +async def list_public_trades(url: str, key: str, *, delivery_start: datetime) -> None: + """List trades and stream new public trades. If delivery_start is provided, list historical trades and stream new trades for the 15 minute delivery period starting at delivery_start. @@ -116,10 +116,10 @@ async def list_gridpool_trades( print_trade(trade) -async def list_orders( +async def list_gridpool_orders( url: str, key: str, *, delivery_start: datetime, gid: int ) -> None: - """List orders and stream new orders. + """List orders and stream new gridpool orders. If delivery_start is provided, list historical orders and stream new orders for the 15 minute delivery period starting at delivery_start.