search

pyOpenSci / python-package-guide

scientific Python package recommendations & guidance curated by pyOpenSci
https://www.pyopensci.org/python-package-guide/
Other
70 stars 43 forks source link

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

Open zackw opened 1 month ago

zackw commented 1 month ago

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)

willingc commented 1 month ago

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

ofek commented 1 month ago

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 commented 1 month ago

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

lwasser commented 3 weeks ago

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 !! 🚀