Skip to content

Commit 21bf183

Browse files
authored
Update version in README (frequenz-floss#130)
Also clear release notes and some minor fixes to README.
2 parents e011e8b + 7c45c9b commit 21bf183

File tree

2 files changed

+6
-13
lines changed

2 files changed

+6
-13
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,29 +30,29 @@ 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.11.0
33+
VERSION=0.12.0
3434
pip install frequenz-client-reporting==$VERSION
3535
```
3636

3737

3838
### Initialize the client
3939

4040
```python
41-
from datetime import datetime
41+
from datetime import datetime, timedelta
4242

4343
from frequenz.client.common.metric import Metric
4444
from frequenz.client.reporting import ReportingApiClient
4545

4646
# Change server address if needed
47-
SERVER_URL = "grpc://reporting.api.frequenz.com:443?ssl=true"
47+
SERVER_URL = "grpc://reporting.api.frequenz.com:443"
4848
API_KEY = open('api_key.txt').read().strip()
4949
client = ReportingApiClient(server_url=SERVER_URL, key=API_KEY)
5050
```
5151

52-
Besides the microgrid_id, component_ids, and metrics, start, and end time,
52+
Besides the `microgrid_id`, `component_id`s, `metrics`, start, and end time,
5353
you can also set the sampling period for resampling using the `resampling_period`
54-
parameter. For example, to resample data every 15 minutes, use a `resampling_period`
55-
of timedelta(minutes=15).
54+
parameter. For example, to resample data every 15 minutes, use
55+
`resampling_period=timedelta(minutes=15)`.
5656

5757
### Query metrics for a single microgrid and component:
5858

RELEASE_NOTES.md

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

77
## Upgrading
88

9-
* Update repo-config and setuptools versions
10-
* Timestamps in the response are now timezone aware.
119

1210
## New Features
1311

14-
* Support for streaming: By omitting the end date in the request,
15-
the client will return any historical data from timestamp until now and
16-
keep streaming new data as it arrives.
17-
* Also the start date can be omitted which let's the data start at the
18-
earliest time stamp that is available.
1912

2013
## Bug Fixes
2114

0 commit comments

Comments
 (0)