Skip to content

Rename list_ commands in CLI tool #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwasicki merged 1 commit into from
Jan 31, 2025
Merged

Rename list_ commands in CLI tool #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@

* Add trading-cli tool to interact with the trading API. Supports the following commands:
* `list-day-ahead`: Listing day-ahead prices from the entsoe API.
* `list-trades`: Listing and streaming public trades for specified delivery periods. If no delivery start is given, starts streaming all new public trades.
* `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.
* `receive-trades`: Listing and streaming public trades for specified delivery periods. If no delivery start is given, starts streaming all new public trades.
* `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.
* `create-order`: Creating a limit order for a given price (in EUR/MWh) and quantity (in MW, sign determines market side).
* `cancel-order`: Cancel individual orders for a gridpool.
* `cancel-all-orders`: Cancels all orders of a gridpool.
Expand Down
8 changes: 4 additions & 4 deletions src/frequenz/client/electricity_trading/cli/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ 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 list_trades(url: str, key: str, *, start: datetime) -> None:
"""List trades."""
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))


Expand All @@ -55,8 +55,8 @@ def list_trades(url: str, key: str, *, start: datetime) -> None:
@click.option("--key", required=True, type=str)
@click.option("--start", default=None, type=iso)
@click.option("--gid", required=True, type=int)
def list_orders(url: str, key: str, *, start: datetime, gid: int) -> None:
"""List orders."""
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))


Expand Down
Loading