Skip to content

Commit 74292c6

Browse files
authored
Update README with reporting-cli usage instructions (#71)
2 parents df5fec8 + d853224 commit 74292c6

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Please also refer to [examples](https://github.com/frequenz-floss/frequenz-clien
3030

3131
```bash
3232
# Choose the version to install
33-
VERSION=0.4.0
33+
VERSION=0.5.0
3434
pip install frequenz-client-reporting==$VERSION
3535
```
3636

@@ -102,16 +102,18 @@ df = pd.DataFrame(data)
102102
print(df)
103103
```
104104

105-
## Command line client example
105+
## Command line client tool
106106

107-
The example folder contains a simple client that can be used to query the reporting API from the command line:
107+
The package contains a command-line tool that can be used to request data from the reporting API.
108108
```bash
109-
python examples/client.py \
109+
reporting-cli \
110110
--url localhost:4711 \
111111
--key=$(<api_key.txt)
112112
--mid 42 \
113113
--cid 23 \
114114
--metrics AC_ACTIVE_POWER AC_REACTIVE_POWER \
115115
--start 2024-05-01T00:00:00 \
116-
--end 2024-05-02T00:00:00
116+
--end 2024-05-02T00:00:00 \
117+
--format csv
117118
```
119+
In addition to the default CSV format the data can be output as individual samples or in `dict` format.

0 commit comments

Comments
 (0)