feat: enhance README.md with Quick Start section and improved installation instructions #221
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
github-actions
bot
added
part:docs
Marenz
force-pushed
the
improve-readme-182
branch
from
e01cf18 to
5b74a4b
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the README.md with better onboarding experience by adding a Quick Start section and expanding installation options. It also includes a bug fix for CLI timestamp handling to ensure date-only inputs default to midnight UTC.
- Added Quick Start section with an improved code example for faster user onboarding
- Expanded Installation section to include pip, Poetry, and source installation methods
- Fixed CLI timestamp parsing to handle date-only inputs consistently by defaulting to midnight UTC
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Enhanced with Quick Start section and multiple installation methods |
| src/frequenz/client/dispatch/_cli_types.py | Fixed date-only timestamp parsing to default to midnight UTC |
| tests/test_cli.py | Added test coverage for the new FuzzyDateTime date-only parsing behavior |
| RELEASE_NOTES.md | Documented the CLI timestamp parsing fix |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Marenz
force-pushed
the
improve-readme-182
branch
from
d246067 to
b5d6ecf
Compare
…ation instructions - Add dedicated Quick Start section for faster onboarding - Expand Installation section with multiple installation methods - Improve code examples and documentation structure Closes: frequenz-floss#182 Signed-off-by: Mathias L. Baumann <[email protected]>
Marenz
force-pushed
the
improve-readme-182
branch
from
b5d6ecf to
09f660c
Compare
Marenz
added
the
cmd:skip-release-notes
llucax
reviewed
Oct 10, 2025
|
|
||
| ```bash | ||
| poetry add frequenz-client-dispatch | ||
| ``` |
There was a problem hiding this comment.
I would skip this, otherwise we need to include also uv, conda, pipenv, pdm, etc.
Comment on lines
+31
to
+39
| ### From Source | ||
|
|
||
| To install from source: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/frequenz-floss/frequenz-client-dispatch-python.git | ||
| cd frequenz-client-dispatch-python | ||
| pip install -e . | ||
| ``` |
There was a problem hiding this comment.
This also overlaps with the contributing guide, installing in editable mode just to install for use also feels wrong.
| ## 🚀 Quick Start | ||
|
|
||
| Here's a quick example to get you started: | ||
| Get up and running in minutes with this simple example: |
There was a problem hiding this comment.
Bumping up the marketing? 😆
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Summary
Closes #182