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

Great work - suggestions for tutorial and console output #1

Open
cefn opened this issue May 21, 2018 · 0 comments
Open

Great work - suggestions for tutorial and console output #1

cefn opened this issue May 21, 2018 · 0 comments

Comments

@cefn
Copy link

cefn commented May 21, 2018

This is a great little utility and I hope it is able to be maintained.

As you have probably noticed at pypa/pip#3813 there was a big issue around the message which should be shown to the user, regardless of what changes might be made.

Unfortunately I think pybin retains some of these issues of documentation and understandability in terms of the guidance and messages shown, but I think they may be easily fixed with your help.

Fix 1: Change the github README instructions so that users run python3 -m pybin

I suffer from the Debian curse of no .local/bin in my $PATH . Of course, this means that it is impossible to run pybin which is in .local/bin, which defeats its own purpose. Running the 'package main' of pybin using the -m option works regardless if .local/bin is on the path or not.

Fix 2: Provide an instruction showing how to fix the issue

I ran the following...

python3 -m pybin 
The user bin directory `/home/cefn/.local/bin` is not in PATH.

...but I was disappointed that it didn't offer a fix. It should instead read as follows.

python3 -m pybin 
The user bin directory `/home/cefn/.local/bin` is not in PATH.
Run type the following line and press enter to fix your path...
python3 -m pybin put

Alternatively you could have pybin by default offer an interactive prompt to fix a non-existent path, with flags to override interactive (do nothing) or force (change the path non-interactively).

Success!

I ran...

python3 -m pybin put
Success!

..and it had successfully added the path line to the end of my .bashrc. Brilliant! This will be very useful for me as an educator working with learners who may be following my instructions to install python3 at home, as part of the VGKits Vanguard project.

Thanks for your intervention. It could save a world of pain for lots of people.

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

No branches or pull requests

1 participant