Skip to content

Update README.md: Added uv section#3677

Open
davidhedlund wants to merge 1 commit into
vacanza:devfrom
davidhedlund:patch-3
Open

Update README.md: Added uv section#3677
davidhedlund wants to merge 1 commit into
vacanza:devfrom
davidhedlund:patch-3

Conversation

@davidhedlund

@davidhedlund davidhedlund commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Proposed change

  • There is an inconsistency in the documentation: the GitHub README states that pip should be used but does not mention uv. Conversely, the ReadTheDocs Examples page recommends using uv instead of pip. We should align these to avoid confusing users.
  • On Debian and Ubuntu distributions, pip is not pre-installed, and pip3 requires manual installation along with the --break-system-packages flag to run. Using uv bypasses these hurdles completely with a simple, hassle-free installation.

Partially fixes:

Your PR description goes here.

Type of change

  • New country/market holidays support (thank you!)
  • Supported country/market holidays update (calendar discrepancy fix, localization)
  • Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
  • Dependency update (version deprecation/pin/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new holidays functionality in general)

Checklist

Partially fixed:
* vacanza#3670

Signed-off-by: David Hedlund <davidhedlund@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The README's "Install" section is replaced with a new "Installation & execution" section, splitting instructions into pip-based and uv-based installation and execution paths, including quick-run and script usage examples.

Changes

README Installation Docs

Layer / File(s) Summary
Pip installation and quick run instructions
README.md
Adds pip stable install/update, GitHub dev install, dev-to-main note, and a CLI quick-run example replacing the old "Install" section.
Uv installation and execution instructions
README.md
Adds uvx one-off execution instructions and examples for interactive shell and local script usage with holidays.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Related PRs: None identified.

Suggested labels: documentation

Suggested reviewers: None identified.

Poem: A rabbit hops through docs anew, / Pip and uv, both in view. / Install, quick-run, a script to try, / README's clearer, no need to sigh.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title matches the main change: adding a uv section to the README.
Description check ✅ Passed The description is clearly related to the README installation update and the uv documentation change.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@davidhedlund davidhedlund changed the title Update README.md: Added `uv section Update README.md: Added uv section Jul 4, 2026
@sonarqubecloud

sonarqubecloud Bot commented Jul 4, 2026

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Re-trigger cubic

@KJhellico

Copy link
Copy Markdown
Collaborator
  • There is an inconsistency in the documentation: the GitHub README states that pip should be used but does not mention uv. Conversely, the ReadTheDocs Examples page recommends using uv instead of pip. We should align these to avoid confusing users.

There's no inconsistencies here. You're mixing recommendations for a user who needs a library (developer) with those for a user who just needs a tool to generate iCalendar files. And when I said that uv should be mentioned, I simply meant that it would be helpful to mention uv add holidays alongside pip install holidays for those who use uv.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants