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

provide a pyscaffold command to inform users that the command they want is putup #616

Open
julie777 opened this issue Feb 20, 2022 · 4 comments

Comments

@julie777
Copy link

Describe your use-case

When a python developer is browsing PyPI and sees and interesting tool, they often don't even read all of the pypi page, or they may have seen the tool mentioned in some discussion somewhere.
Often the user will just pip install and then type "toolname --help" to check it out. Currently they will get command not found when trying to run pyscaffold.

Describe the solution you would like to see for your use-case

Add a simple stub executable pyscaffold that no matter how it is run informs the user that the command for pyscaffold is putup.

@abravalheri
Copy link
Collaborator

I think we can 2 things here:

  1. Add a pyscaffold command that effectively runs putup
    • Rationale: this allows people to run pipx run pyscaffold myproj (currently they have to run pipx run --spec pyscaffold putup myproj).
  2. Add the necessary bits to make python -m putup or python -m pyscaffold run the same as putup
    • Rationale: this allows people to run PyScaffold even if .local/bin is not added to PATH.

@FlorianWilhelm
Copy link
Member

To play the devil's advocate here 😉 Where there ever people confused about it? It's really only a few lines when reading the quickstart section. Could people be confused between putup and the pyscaffold command then? Would we call it pyscaffold or putup in the docs?

@julie777
Copy link
Author

I don't think pyscaffold should be an alias for putup.

I was just suggesting we put forth a minimal effort to keep lazy users from being confused. (My suggestion was based on another thread.) I didn't have any plans to put it in the documentation. To me it was similar to typing more not adding a file name. It gives you a little nudge in the right direction.

Maybe we should just table this if there is any concern about it.

@FlorianWilhelm
Copy link
Member

I like @julie777 idea of having a pyscaffold command that says basically: To use PyScaffold, please use the 'putup' command and read the docs ....

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

3 participants