Skip to content

Commit ce2a7c7

Browse files
authored
Update README w.r.t states and bounds (#101)
Also clear release notes.
2 parents e1617f3 + 1b21d95 commit ce2a7c7

File tree

2 files changed

+6
-12
lines changed

2 files changed

+6
-12
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.

RELEASE_NOTES.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,9 @@
66

77
## Upgrading
88

9-
* Update and fix readme to make use of newest release version 0.8.0
10-
* Updates the base client to version 0.6.
119

1210
## New Features
1311

14-
* States can now be requested via the client and are provided through the flat iterator.
15-
They can be identified via their category `state`, `warning` and `error`, respectively.
16-
Each individual state is provided as its own sample.
17-
* Bounds can now be requested via the client and are provided through the flat iterator.
18-
They can be identified via their category `metric_bound[i]_{upper,lower}`.
19-
Each individual bound is provided as its own sample.
20-
21-
* Support for states and bound is also added to the CLI tool via the `--states` and `--bounds` flag, respectively.
2212

2313
## Bug Fixes
2414

0 commit comments

Comments
 (0)