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

docs: Document plugin development with uv and how to migrate existing ones #2861

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Jan 31, 2025

Related

Summary by Sourcery

Documentation:

  • Document plugin development with uv alongside Poetry.

Copy link
Contributor

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request updates the documentation to include instructions for using uv as a package manager, in addition to poetry. It also includes a new guide for migrating from poetry to uv.

Flow diagram for migrating from Poetry to uv

flowchart TD
    A[Start Migration] --> B[Install uv]
    B --> C[Run uvx migrate-to-uv]
    C --> D[Update build-system in pyproject.toml]
    D --> E[Update CI/CD configs]
    E --> F[Replace poetry commands with uv]
    F --> G[Migration Complete]

    subgraph Command Changes
    H[poetry install] --> I[uv sync]
    J[poetry add] --> K[uv add]
    L[poetry run] --> M[uv run]
    end
Loading

File-Level Changes

Change Details Files
Added documentation for using uv as a package manager.
  • Added uv tabs to code examples.
  • Added uv commands to code examples.
  • Updated documentation to include uv as a package manager.
  • Replaced poetry with uv in some documentation.
  • Added uv to the list of package managers in the documentation.
docs/cli_commands.md
docs/guides/porting.md
docs/python_tips.md
docs/dev_guide.md
docs/guides/custom-clis.md
docs/CONTRIBUTING.md
docs/faq.md
docs/implementation/logging.md
Added a new guide for migrating from poetry to uv.
  • Added a new guide for migrating from poetry to uv.
  • Added a link to the new guide in the index.
docs/guides/migrate-to-uv.md
docs/index.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 self-assigned this Jan 31, 2025
@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/docs/doc-uv-dev branch from 59cd077 to 4c5ee06 Compare January 31, 2025 17:11
@edgarrmondragon edgarrmondragon added the Documentation Improvements or additions to documentation label Jan 31, 2025
@edgarrmondragon edgarrmondragon changed the title docs: Document plugin development with uv docs: Document plugin development with uv and how to migrate existing ones Jan 31, 2025
@edgarrmondragon edgarrmondragon marked this pull request as ready for review January 31, 2025 17:13
@edgarrmondragon edgarrmondragon requested review from tayloramurphy and a team as code owners January 31, 2025 17:13
@edgarrmondragon edgarrmondragon merged commit a609f4b into main Jan 31, 2025
9 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/docs/doc-uv-dev branch January 31, 2025 17:13
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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 4 issues 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/faq.md Show resolved Hide resolved
docs/guides/custom-clis.md Show resolved Hide resolved
docs/guides/porting.md Show resolved Hide resolved
docs/guides/porting.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant