diff --git a/README.md b/README.md index 4716231..1fa0a04 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Please also refer to [examples](https://github.com/frequenz-floss/frequenz-clien ```bash # Choose the version you want to install -VERSION=0.11.0 +VERSION=0.12.0 pip install frequenz-client-reporting==$VERSION ``` @@ -38,21 +38,21 @@ pip install frequenz-client-reporting==$VERSION ### Initialize the client ```python -from datetime import datetime +from datetime import datetime, timedelta from frequenz.client.common.metric import Metric from frequenz.client.reporting import ReportingApiClient # Change server address if needed -SERVER_URL = "grpc://reporting.api.frequenz.com:443?ssl=true" +SERVER_URL = "grpc://reporting.api.frequenz.com:443" API_KEY = open('api_key.txt').read().strip() client = ReportingApiClient(server_url=SERVER_URL, key=API_KEY) ``` -Besides the microgrid_id, component_ids, and metrics, start, and end time, +Besides the `microgrid_id`, `component_id`s, `metrics`, start, and end time, you can also set the sampling period for resampling using the `resampling_period` -parameter. For example, to resample data every 15 minutes, use a `resampling_period` -of timedelta(minutes=15). +parameter. For example, to resample data every 15 minutes, use +`resampling_period=timedelta(minutes=15)`. ### Query metrics for a single microgrid and component: diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index a12cec8..f8640ca 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -6,16 +6,9 @@ ## Upgrading -* Update repo-config and setuptools versions -* Timestamps in the response are now timezone aware. ## New Features -* Support for streaming: By omitting the end date in the request, - the client will return any historical data from timestamp until now and - keep streaming new data as it arrives. -* Also the start date can be omitted which let's the data start at the - earliest time stamp that is available. ## Bug Fixes