Skip to content

Conversation

@hagenw
Copy link
Member

@hagenw hagenw commented Jun 5, 2025

Use uv to manage the package development.

Changes include:

  • Replacing tests/requirements.txt and docs/requirements.txt by a dev group in pyproject.toml (which is automatically installed by uv)
  • Removing requirements.txt
  • Update CONTRIBUTING.rst to use uv run for testing and building docs
  • Use uv build instead of python -m build inside the Github Action to publish the package

Summary by Sourcery

Switch to uv for dependency and task management by consolidating dev dependencies in pyproject.toml, removing legacy requirements files, and updating CI workflows and documentation to use uv commands.

Enhancements:

  • Add dev dependency group in pyproject.toml to centralize development requirements
  • Remove requirements.txt, docs/requirements.txt, and tests/requirements.txt files

CI:

  • Install uv in all GitHub Actions workflows and replace pip-based steps with uv sync, uv run, uv build, and uvx commands

Documentation:

  • Update CONTRIBUTING.rst and documentation instructions to use uv commands instead of pip

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 5, 2025

Reviewer's Guide

This PR replaces pip-based dependency management and CI steps with uv-driven workflows by defining a dev group in pyproject.toml, removing legacy requirements files, updating CONTRIBUTING instructions, and migrating all GitHub Actions to use uv commands.

File-Level Changes

Change Details Files
Define a development dependency group in pyproject.toml
  • Add [dependency-groups].dev section
  • Include testing, documentation, and utility packages under dev
pyproject.toml
Remove legacy requirements files
  • Delete requirements.txt
  • Remove docs/requirements.txt and tests/requirements.txt
requirements.txt
docs/requirements.txt
tests/requirements.txt
Update CONTRIBUTING instructions to use uv
  • Replace pip install steps with uv run and uv sync commands
  • Switch build and test directives to uv-based invocations
CONTRIBUTING.rst
Migrate CI workflows to uv-driven commands
  • Install uv via astral-sh/setup-uv@v5 in each workflow
  • Replace pip install and python -m build with uv sync, uv run, uv build
  • Use uvx for pre-commit and uv run for pytest and sphinx
.github/workflows/doc.yml
.github/workflows/publish.yml
.github/workflows/test.yml
.github/workflows/linter.yml

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!

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

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 @hagenw - I've reviewed your changes and they look great!

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.

@hagenw hagenw merged commit 3723bc3 into main Jun 5, 2025
19 checks passed
@hagenw hagenw deleted the uv branch June 5, 2025 13:47
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