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] Clarification: hatch --version throws error on Windows OS #271

Open sn3hay opened 1 month ago

sn3hay commented 1 month ago

Description Reference: https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html After installing the Hatch, if the path where pipx puts these applications is not on the PATH environment variable, then it is required to run pipx ensurepath to automatically add it or manual modification of the PATH is required.

Steps to Reproduce After installing Hatch on Windows OS run hatch --version

Expected Behavior The hatch version command should be recognized and return the version.

Actual Behavior The error message - 'hatch' is not recognized as an internal or external command, operable program or batch file.

Solution Run pipx ensurepath Reopen command line and run hatch --version This should now return the version of Hatch installed.

This is not a bug report but rather clarification that would ease the installation of Hatch.

pb-413 commented 1 month ago

Possibly related to #265.

willingc commented 1 month ago

Related to #265 and #270. Using suggested fix in these issues will resolve this too.

Next action: https://github.com/pyOpenSci/python-package-guide/issues/270#issuecomment-2138319940

kierisi commented 1 month ago

@all-contributors add @sn3hay for review

allcontributors[bot] commented 1 month ago

@kierisi

I've put up a pull request to add @sn3hay! :tada:

lwasser commented 5 days ago

y'all - i've just opened this pr which updates the installation instructions - if you are involved in multiple issues you'll see this same comment on all of them (i'm housekeeping)

A few things we learned chatting in #301

  1. the installers seem to be the way to go for windows and MAC (altho mac also supports homebrew install which people might have and prefer)
  2. Hatch installs Python for you using UV if you don't have Python! so the installers provide an additional win of Python!

Reviews are welcome on my open PR!! we are teaching a workshop the week after next so i'll leave this open for a week with the plan to merge next tuesday July 2! this issue can then be closed! 🚀