-
Notifications
You must be signed in to change notification settings - Fork 59
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
Conversation
Reviewer's Guide by SourceryThis pull request changes the installation method from Sequence diagram for installation process changesequenceDiagram
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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
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 |
There was a problem hiding this comment.
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]>
c381baa
to
4b80a8c
Compare
LGTM |
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: