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

[UX] Need "step 0: get Python and Hatch" on https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html #270

Closed
zackw opened this issue May 20, 2024 · 5 comments
Labels
beginner-friendly help wanted We welcome a contributor to work on this issue! thank you in advance! new-content New feature or request sprintable UX User experience

Comments

@zackw
Copy link

zackw commented May 20, 2024

People who aren't real familiar with what already comes with the OS, and what comes with core Python, may get stuck in step one of https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html when the recommended "pipx install hatch" command throws a "no such command pipx" error message.

Those instructions should come with a leader reminding people that they need to have Python installed in the first place, and then that Hatch is not part of core Python and needs to be installed itself. As discussed face-to-face in the sprint, it may make sense to drop pipx entirely and just recommend "pip install hatch" for naive users.

(Related to #265)

@zackw zackw changed the title Need Need "step 0: get Python and Hatch" May 20, 2024
@zackw zackw changed the title Need "step 0: get Python and Hatch" Need "step 0: get Python and Hatch" on https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html May 20, 2024
@willingc willingc added the UX User experience label May 29, 2024
@willingc willingc changed the title Need "step 0: get Python and Hatch" on https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html [UX] Need "step 0: get Python and Hatch" on https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html May 29, 2024
@willingc
Copy link
Collaborator

@lwasser Makes sense to use pip unless @ofek has a reason for pipx to be preferable.

@ofek
Copy link
Contributor

ofek commented May 29, 2024

My recommendation is for not requiring a manual Python installation at all and rather use one of the Hatch installers or binaries. I mentioned that in the blog post for 1.8 https://hatch.pypa.io/latest/blog/2023/12/11/hatch-v180/

Installation docs: https://hatch.pypa.io/latest/install/

@willingc
Copy link
Collaborator

Ooh cool @ofek. I didn't realize that there were installers now. Thanks!

@lwasser
Copy link
Member

lwasser commented Jun 6, 2024

TODO:

go to this tutorial - https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html - the first step is "pipx install hatch"

we should likely change this step to use the hatch installers which are detailed on this page

let's also include a small "note" on that page that links to @ofek blog post on the hatch installers!

to add a note you'd use this syntax in our theme

Learn more about installing hatch using the hatch installers (which do not require python, pip or pipx to be preinstalled), [in this blog post](https://hatch.pypa.io/latest/blog/2023/12/11/hatch-v180/).  

This is also a very user friendly issue but we will need someone to test this installation out on windows FIRST before adding / revising the tutorial. we've already had people test it on mac successfully! 

We'd then want to remove any language about using pipx here. so much better / begginer friendly! thank you @ofek and everyone !! 🚀 

@lwasser lwasser added help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable beginner-friendly labels Jun 6, 2024
@lwasser
Copy link
Member

lwasser commented Jul 11, 2024

Friends - i believe we can close this issue
we have now

✅ updated the tutorial page to specify using the installers rather than pipx (which removed singificant issues we were having!
✅ removed the discussion of installing python given Hatch will install for a user
✅ we tested this approach yesterday in our second workshop (in person at scipy). everyone was able to get hatch installed.

NOTE:there is a nuance with the installers where somtimes they will beging to download updates when a user runs hatch --version. this was a bit confusing so we may want to add a note about this behavior given it makes the user think that hatch is not installed yet. i will open a new issue about that soon but will close this issue for the time being as completed!

if anyone disagrees wtih this being completed please do feel free to reply here!! ✨ and we can reopen!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner-friendly help wanted We welcome a contributor to work on this issue! thank you in advance! new-content New feature or request sprintable UX User experience
Development

No branches or pull requests

4 participants