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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

add instructions to install python CLI applications with pipx #594

Merged
merged 6 commits into from Feb 20, 2019

Conversation

@cs01
Copy link
Contributor

cs01 commented Jan 28, 2019

pipx (https://github.com/cs01/pipx) is a command execution tool like pipsi, and was mentioned in this thread. #406

Pipsi is no longer maintained, and pipx (my project) hopes to pick up where pipsi left off.

I took a shot at adding a section to the installation tutorial. I think this type of tool provides a lot of value to the python community yet doesn鈥檛 seem to be very well known. Hopefully this will change that 馃槃 .

@theacodes

This comment has been minimized.

Copy link
Member

theacodes commented Jan 28, 2019

Hi @cs01! Thank you for doing this. This content is great, but I'd prefer it be under "guides" instead of "tutorials". The reason being is that tutorials should be focused on accomplishing a single task with the minimal amount of tools and information. In fact, this particular tutorial has been on my list to clean up for a while. "Guides", on the other hand, are great for things that explore specific use cases. How would you feel about moving this to a guide and possibly linking to it from the tutorial?

@cs01

This comment has been minimized.

Copy link
Contributor Author

cs01 commented Jan 28, 2019

Thanks for the quick reply!

How would you feel about moving this to a guide and possibly linking to it from the tutorial?

Sure, not a problem.

Which part of the guide do you think it belongs in? And what type of content should I leave in the tutorial? The same section that I just added but with just a link to the guide?

@theacodes

This comment has been minimized.

Copy link
Member

theacodes commented Jan 28, 2019

A new guide, all for itself! Something like "Installing stand-alone command line tools" would work.

And what type of content should I leave in the tutorial?

Maybe just a note or a link at the bottom that says something like "If you're looking to install stand-alone command line tools, consider using pipx".

@cs01

This comment has been minimized.

Copy link
Contributor Author

cs01 commented Jan 28, 2019

Awesome, thank you! Will add a new commit tonight or in the next few days when I have the time.

@cs01

This comment has been minimized.

Copy link
Contributor Author

cs01 commented Jan 29, 2019

Replaced tutorial with new guide "Installing stand alone command line tools" and also added a link in the installation tutorial.

@ncoghlan

This comment has been minimized.

Copy link
Member

ncoghlan commented Jan 30, 2019

Tangent: only reading the comments without reading the PR itself, I was confused by the fact that https://pypi.org/project/pipx/ is not the pipx being referred to here. So while I can understand the desire to use the name pipx by analogy with npx, I think it will be incredibly confusing for end users when the naive bootstrapping approach of running pip install --user pipx and managing pipx using pip rather than itself doesn't actually work. (Before reading your guide I assumed I'd be able to just replace pipsi with pipx in my current bootstrapping instructions, but that isn't the case)

The simplest resolution might be to open on issue on https://github.com/khalti/pipx and ask the Khalti folks if they'd be willing to relinquish the pipx name on PyPI to you - given the only change they've made since August 2017 is to add a note pointing out that the project isn't actually maintained, they may be willing to help you out.

I don't think that concern should block merging the guide though - I'll just note in the draft guide where I think a bit more clarification would be helpful.

@theacodes

This comment has been minimized.

Copy link
Member

theacodes commented Feb 1, 2019

Actually, that would be ideal. @cs01 Do you mind holding off on this until we hear back from the pipx folks? If you would like, I can reach out to them on your behalf.

@cs01

This comment has been minimized.

Copy link
Contributor Author

cs01 commented Feb 1, 2019

Actually, that would be ideal. @cs01 Do you mind holding off on this until we hear back from the pipx folks? If you would like, I can reach out to them on your behalf.

Sounds good. I was going to suggest the same thing to avoid churn in the docs. Nick's request was agreed to (khalti/pipx#2), so now I am waiting on @ludbek to grant me access.

@theacodes

This comment has been minimized.

Copy link
Member

theacodes commented Feb 1, 2019

@ludbek

This comment has been minimized.

Copy link

ludbek commented Feb 1, 2019

@ncoghlan @cs01 Its done. Good luck with the new project.

@ncoghlan

This comment has been minimized.

Copy link
Member

ncoghlan commented Feb 2, 2019

@ludbek Thank you!

cs01 added 2 commits Feb 8, 2019
鈥tions; document pipx list
@cs01

This comment has been minimized.

Copy link
Contributor Author

cs01 commented Feb 8, 2019

@ncoghlan thanks for helping to get the pipx name transferred over to me 馃槃.

@ncoghlan @theacodes I've updated pipx on PyPI and these docs, so it's ready for another review 馃槃.

cs01 added 2 commits Feb 9, 2019
Copy link
Member

ncoghlan left a comment

Thanks @cs01 - this looks good to me now!

@ncoghlan

This comment has been minimized.

Copy link
Member

ncoghlan commented Feb 16, 2019

@theacodes Since this is a whole new guide, l figure it's worthwhile leaving pushing the big green button to you so that it gets two pre-merge reviews :)

@theacodes

This comment has been minimized.

Copy link
Member

theacodes commented Feb 20, 2019

Thank you, @cs01 for writing and @ncoghlan for reviewing. :)

@theacodes theacodes merged commit 1e5db9e into pypa:master Feb 20, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can鈥檛 perform that action at this time.