Skip to content
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.

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

packaging: Use uv to manage this project #2851

Merged
merged 2 commits into from
Jan 31, 2025

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Jan 31, 2025

Motivation

Potential issues

Summary by Sourcery

Switch to using uv for managing project dependencies and development tools.

Build:

  • Replace poetry with uv for managing project dependencies and virtual environments.

CI:

  • Update CI workflows to use uv instead of poetry.

Documentation:

  • Update documentation to reflect the switch from poetry to uv for managing dependencies and development tools.

📚 Documentation preview 📚: https://meltano-sdk--2851.org.readthedocs.build/en/2851/

Copy link
Contributor

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request migrates the project from Poetry to uv for dependency management and build processes. It also updates the documentation and CI workflows to reflect this change.

Flow diagram: Updated development setup process

flowchart TD
    Start[Start Development Setup] --> InstallUV[Install uv]
    InstallUV --> InstallTools[Install tools with uv]
    InstallTools --> |pre-commit| Tools1[Install pre-commit]
    InstallTools --> |nox| Tools2[Install nox]
    Tools1 --> InstallDeps[Install dependencies]
    Tools2 --> InstallDeps
    InstallDeps --> |uv sync| AllDeps[Install all dependencies and extras]
    AllDeps --> PreCommit[Setup pre-commit hooks]
    PreCommit --> Done[Setup Complete]
Loading

File-Level Changes

Change Details Files
Replaced Poetry with uv and Hatchling for dependency management and build processes.
  • Removed Poetry configuration.
  • Added Hatchling configuration for build system.
  • Updated dependency groups to use uv format.
  • Replaced poetry-dynamic-versioning with hatch-vcs for version management.
  • Added uv configuration.
pyproject.toml
Updated contributing documentation to reflect the switch from Poetry to uv.
  • Replaced Poetry installation instructions with uv installation instructions.
  • Updated dependency installation instructions to use uv.
  • Updated VSCode interpreter selection instructions to use uv's virtualenv.
  • Updated test execution instructions to use uv.
docs/CONTRIBUTING.md
Updated CI workflows to use uv instead of Poetry.
  • Replaced Poetry installation with uv installation.
  • Replaced Poetry dependency installation with uv dependency installation.
  • Removed poetry.lock file from workflow triggers.
  • Added uv.lock file to workflow triggers.
.github/workflows/codspeed.yml
.github/workflows/test.yml
Updated pre-commit configuration to use uv.
  • Replaced poetry-check hook with uv-lock and uv-sync hooks.
  • Added uv-lock to the skip list.
.pre-commit-config.yaml
Updated noxfile to use uv.
  • Updated noxfile to load dependency groups from pyproject.toml in uv format.
noxfile.py
Removed unused files.
  • Removed uv.lock file.
  • Removed Makefile.
  • Removed poetry.lock file.
uv.lock
docs/Makefile
poetry.lock

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/packaging/uv-hatchling branch 6 times, most recently from 0148514 to f158017 Compare January 31, 2025 02:16
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.34%. Comparing base (b0effe8) to head (fa3166e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2851   +/-   ##
=======================================
  Coverage   91.34%   91.34%           
=======================================
  Files          62       62           
  Lines        5209     5209           
  Branches      673      673           
=======================================
  Hits         4758     4758           
  Misses        319      319           
  Partials      132      132           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

codspeed-hq bot commented Jan 31, 2025

CodSpeed Performance Report

Merging #2851 will not alter performance

Comparing edgarrmondragon/packaging/uv-hatchling (fa3166e) with main (b0effe8)

Summary

✅ 7 untouched benchmarks

@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/packaging/uv-hatchling branch from f158017 to d168fe8 Compare January 31, 2025 02:20
@edgarrmondragon edgarrmondragon self-assigned this Jan 31, 2025
@edgarrmondragon edgarrmondragon marked this pull request as ready for review January 31, 2025 02:30
@edgarrmondragon edgarrmondragon requested review from a team and tayloramurphy as code owners January 31, 2025 02:30
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @edgarrmondragon - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief explanation in the PR description about the motivation and benefits of switching from Poetry to uv (e.g., performance improvements, simplified dependency management, etc).
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@edgarrmondragon edgarrmondragon merged commit ea4459b into main Jan 31, 2025
35 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/packaging/uv-hatchling branch January 31, 2025 02:41
@edgarrmondragon edgarrmondragon added this to the v0.44 milestone Jan 31, 2025
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.

1 participant