Skip to content

Commit 1b21d95

Browse files
committed
Update readme version and example on states and bounds
Signed-off-by: cwasicki <[email protected]>
1 parent 9547b60 commit 1b21d95

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 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 you want to install
33-
VERSION=0.8.0
33+
VERSION=0.9.0
3434
pip install frequenz-client-reporting==$VERSION
3535
```
3636

@@ -92,6 +92,8 @@ data = [
9292
start_dt=datetime.fromisoformat("2024-05-01T00:00:00"),
9393
end_dt=datetime.fromisoformat("2024-05-02T00:00:00"),
9494
resolution=1,
95+
states=False, # Set to True to include state data
96+
bounds=False, # Set to True to include metric bounds data
9597
)
9698
]
9799
```
@@ -116,6 +118,8 @@ reporting-cli \
116118
--metrics AC_ACTIVE_POWER AC_REACTIVE_POWER \
117119
--start 2024-05-01T00:00:00 \
118120
--end 2024-05-02T00:00:00 \
119-
--format csv
121+
--format csv \
122+
--states \
123+
--bounds
120124
```
121125
In addition to the default CSV format the data can be output as individual samples or in `dict` format.

0 commit comments

Comments
 (0)