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

chore: Update samples to use uv #2860

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Jan 31, 2025

Summary by Sourcery

Update project configuration to use uv instead of poetry.

Build:

  • Replace poetry with uv for dependency management and build processes.

CI:

  • Update CI workflows to use uv instead of poetry for dependency management and testing.

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

@edgarrmondragon edgarrmondragon self-assigned this Jan 31, 2025
Copy link
Contributor

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request updates the sample tap to use uv instead of poetry for dependency management and execution. This includes changes to the pyproject.toml file, the test workflow, and the README.md file.

Class diagram: Project configuration changes in pyproject.toml

classDiagram
    class ProjectConfig {
        +name: string
        +version: string
        +description: string
        +authors: list
        +dependencies: list
        +optional-dependencies: map
        +scripts: map
    }

    class BuildSystem {
        +requires: list
        +build-backend: string
    }

    note for ProjectConfig "Changed from [tool.poetry] to [project]"
    note for BuildSystem "Changed from poetry-core to hatchling"
Loading

File-Level Changes

Change Details Files
Replaced Poetry with uv for dependency management.
  • Removed the [tool.poetry] section.
  • Added the [project] section.
  • Added [tool.uv.sources] section.
  • Updated the [build-system] section to use hatchling.
  • Updated the dependency declarations to use the [project] format.
  • Updated the script declaration to use the [project.scripts] format.
  • Updated the optional dependencies to use the [project.optional-dependencies] format.
  • Updated the dev dependencies to use the [dependency-groups] format.
samples/sample_tap_dummy_json/pyproject.toml
Updated the GitHub Actions workflow to use uv.
  • Replaced the Install Poetry step with Set up uv step.
  • Removed the poetry env use command.
  • Replaced poetry run pytest with uv run -p ${{ matrix.python-version }} pytest.
samples/sample_tap_dummy_json/.github/workflows/test.yml
Updated the README.md to reflect the change to uv.
  • Replaced pipx install poetry and poetry install with uv sync.
  • Replaced poetry run pytest with uv run pytest.
  • Replaced poetry run tap-dummyjson --help with uv run tap-dummyjson --help.
samples/sample_tap_dummy_json/README.md
Updated the AAPL sample to use uv.
  • Replaced poetry run python samples/aapl with uv run python samples/aapl.
  • Replaced poetry run viztracer samples/aapl/__main__.py with uv run viztracer samples/aapl/__main__.py.
  • Replaced poetry run vizviewer result.json with uv run vizviewer result.json.
samples/aapl/README.md

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/chore/update-samples-uv branch from 88b9101 to ceb2920 Compare January 31, 2025 16:27
@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/fix/templates-uv branch from 40fda8e to 7bbd2d9 Compare January 31, 2025 16:27
Copy link

codspeed-hq bot commented Jan 31, 2025

CodSpeed Performance Report

Merging #2860 will not alter performance

Comparing edgarrmondragon/chore/update-samples-uv (60782c0) with main (8e297df)

Summary

✅ 7 untouched benchmarks

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 (8e297df) to head (60782c0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2860   +/-   ##
=======================================
  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.

@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/chore/update-samples-uv branch from ceb2920 to 60782c0 Compare January 31, 2025 16:41
@edgarrmondragon edgarrmondragon changed the base branch from edgarrmondragon/fix/templates-uv to main January 31, 2025 16:41
@edgarrmondragon edgarrmondragon marked this pull request as ready for review January 31, 2025 16:45
@edgarrmondragon edgarrmondragon merged commit 052c491 into main Jan 31, 2025
36 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/chore/update-samples-uv branch January 31, 2025 16:45
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