Improve README #208
Merged
Improve README #208
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR improves the README documentation by enhancing usage examples and adding new sections for better user guidance. The changes focus on replacing broken links with working references, adding authorization documentation, and introducing formula usage examples.
- Replaces broken examples link with a reference to the CLI tool source code
- Adds documentation link for authorization and signing details
- Introduces a new section explaining formula usage with practical examples
README.md
Outdated
| ## Usage | ||
|
|
||
| Please also refer to [examples](https://github.com/frequenz-floss/frequenz-client-reporting-python/tree/HEAD/examples) for more detailed usage. | ||
| Please also refer to source of the [CLI tool](src/frequenz/client/reporting/cli/__main__.py) for a practical example of how to use the client. |
There was a problem hiding this comment.
The phrase 'source of the' is grammatically awkward. Consider changing to 'Please also refer to the CLI tool source code for a practical example of how to use the client.'
Suggested change
| Please also refer to source of the [CLI tool](src/frequenz/client/reporting/cli/__main__.py) for a practical example of how to use the client. | |
| Please also refer to the [CLI tool](src/frequenz/client/reporting/cli/__main__.py) source code for a practical example of how to use the client. |
README.md
Outdated
| Note that this endpoint must be used with a `resampling_period`. | ||
| Details on the formula syntax can be found [here](https://github.com/frequenz-floss/frequenz-microgrid-formula-engine-rs/tree/v0.x.x?tab=readme-ov-file#formula-syntax-overview). | ||
|
|
||
| ``` |
There was a problem hiding this comment.
The code block is missing a language identifier. Consider adding 'python' after the opening backticks for proper syntax highlighting: ```python
Suggested change
| ``` | |
| ```python |
cwasicki
force-pushed
the
read
branch
3 times, most recently
from
4ddc60f to
7838e9e
Compare
Signed-off-by: cwasicki <[email protected]>
Signed-off-by: cwasicki <[email protected]>
Signed-off-by: cwasicki <[email protected]>
Signed-off-by: cwasicki <[email protected]>
cwasicki
added
the
cmd:skip-release-notes
Merged
via the queue into
frequenz-floss:v0.x.x
with commit Jul 17, 2025
2707a4f
5 of 6 checks passed
llucax
reviewed
Jul 17, 2025
| - Defining a time range with `start_time` and `end_time` | ||
| - Optional downsampling using `resampling_period` (e.g., `timedelta(minutes=15)`) | ||
| - Selecting specific `microgrid_id` and `component_id`. | ||
| - Choosing one or more `metrics` to retrieve. Available metrics are listed [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.8.0/proto/frequenz/api/common/v1alpha8/metrics/metrics.proto). |
There was a problem hiding this comment.
Not sure if it is much better, but you could also point to the generated docs:
- For pure protobuf: https://frequenz-floss.github.io/frequenz-api-common/v0.8/protobuf-reference/frequenz/api/common/v1alpha8/metrics/metrics/#frequenz-api-common-v1alpha8-metrics-Metric
- For Python it seems the docs are not being properly generated :( https://frequenz-floss.github.io/frequenz-api-common/v0.8/python-reference/frequenz/api/common/v1alpha8/metrics/metrics_pb2/#frequenz.api.common.v1alpha8.metrics.metrics_pb2.Metric
In a near future, we should probably use client-common and that should have a nice Python doc.
This was referenced Jul 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.