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

Change pip to pipx in installation instructions #520

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Conversation

ericcurtin
Copy link
Collaborator

@ericcurtin ericcurtin commented Dec 20, 2024

It's most common to recommend pip even though it doesn't work on various platforms. Let the users with the tricky platforms figure that out.

Summary by Sourcery

Documentation:

  • Updated installation instructions to use pip instead of pipx.

Copy link
Contributor

sourcery-ai bot commented Dec 20, 2024

Reviewer's Guide by Sourcery

This pull request changes the installation method from pipx to pip.

Sequence diagram for installation process change

sequenceDiagram
    participant User as User
    participant PyPI as PyPI Package Registry
    participant System as System Environment

    Note over User, System: Changed from pipx to pip installation
    User->>PyPI: Request ramalama package
    PyPI-->>User: Download package
    User->>System: pip install ramalama
    Note right of System: Package installed in global Python environment<br/>instead of isolated environment
Loading

File-Level Changes

Change Details Files
Changed the installation command
  • Replaced pipx install ramalama with pip install ramalama
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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 @ericcurtin - I've reviewed your changes - here's some feedback:

Overall Comments:

  • This change should not be made. pipx is the recommended tool for installing Python applications like RamaLama as it provides proper isolation and avoids dependency conflicts. Please keep the original pipx installation instructions.
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.

@@ -68,7 +68,7 @@ $ cat /usr/share/ramalama/shortnames.conf
RamaLama is available via PyPi [https://pypi.org/project/ramalama](https://pypi.org/project/ramalama)

```
pipx install ramalama
Copy link
Contributor

Choose a reason for hiding this comment

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

question: Could you share the reasoning for changing from pipx to pip?

While both tools work, pipx is often recommended for installing Python applications as it creates isolated environments and helps avoid dependency conflicts. Was there a specific reason for preferring pip in this case?

It's most common to recommend pip even though it doesn't work on various platforms. Let the users with the tricky platforms figure that out.

Signed-off-by: Eric Curtin <[email protected]>
@rhatdan
Copy link
Member

rhatdan commented Dec 23, 2024

LGTM

@rhatdan rhatdan merged commit 09cbe3d into main Dec 23, 2024
10 of 11 checks passed
@ericcurtin ericcurtin deleted the ericcurtin-patch-1 branch December 23, 2024 13:29
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