Skip to content

Update version in README #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 3, 2025
Merged

Update version in README #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd6d3af
Reset release notes
cwasicki Jan 2, 2025
7c45c9b
Update version in README
cwasicki Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,29 +30,29 @@ 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
```


### 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,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for the apostrophe?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's highlighting that these are variable names and is rendered like this:
image

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah okay, sorry it looked a bit confusing.

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:

Expand Down
7 changes: 0 additions & 7 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading