Skip to content

Commit f868ca7

Browse files
authored
Rename list_ commands in CLI tool (#100)
Fixes #98
2 parents 0bd2f73 + 40c1b32 commit f868ca7

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212

1313
* Add trading-cli tool to interact with the trading API. Supports the following commands:
1414
* `list-day-ahead`: Listing day-ahead prices from the entsoe API.
15-
* `list-trades`: Listing and streaming public trades for specified delivery periods. If no delivery start is given, starts streaming all new public trades.
16-
* `list-orders`: Listing and streaming orders for specified delivery periods and gridpool IDs. If no delivery start is given, starts streaming all new orders for this gridpool ID.
15+
* `receive-trades`: Listing and streaming public trades for specified delivery periods. If no delivery start is given, starts streaming all new public trades.
16+
* `receive-orders`: Listing and streaming orders for specified delivery periods and gridpool IDs. If no delivery start is given, starts streaming all new orders for this gridpool ID.
1717
* `create-order`: Creating a limit order for a given price (in EUR/MWh) and quantity (in MW, sign determines market side).
1818
* `cancel-order`: Cancel individual orders for a gridpool.
1919
* `cancel-all-orders`: Cancels all orders of a gridpool.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ def cli() -> None:
4545
@click.option("--url", required=True, type=str)
4646
@click.option("--key", required=True, type=str)
4747
@click.option("--start", default=None, type=iso)
48-
def list_trades(url: str, key: str, *, start: datetime) -> None:
49-
"""List trades."""
48+
def receive_trades(url: str, key: str, *, start: datetime) -> None:
49+
"""List and/or stream trades."""
5050
asyncio.run(run_list_trades(url=url, key=key, delivery_start=start))
5151

5252

@@ -55,8 +55,8 @@ def list_trades(url: str, key: str, *, start: datetime) -> None:
5555
@click.option("--key", required=True, type=str)
5656
@click.option("--start", default=None, type=iso)
5757
@click.option("--gid", required=True, type=int)
58-
def list_orders(url: str, key: str, *, start: datetime, gid: int) -> None:
59-
"""List orders."""
58+
def receive_orders(url: str, key: str, *, start: datetime, gid: int) -> None:
59+
"""List and/or stream orders."""
6060
asyncio.run(run_list_orders(url=url, key=key, delivery_start=start, gid=gid))
6161

6262

0 commit comments

Comments
 (0)