diff --git a/tutorials/get-to-know-hatch.md b/tutorials/get-to-know-hatch.md index 8d56b821f..becdab231 100644 --- a/tutorials/get-to-know-hatch.md +++ b/tutorials/get-to-know-hatch.md @@ -4,15 +4,34 @@ Our Python packaging tutorials use the tool Hatch. In this tutorial, you will install and get to know hatch a bit more before starting to use it. ## Install Hatch -To begin, install Hatch following the -[instructions here](https://hatch.pypa.io/latest/install/). +To begin, install Hatch from the command line using [pipx](https://pipx.pypa.io/stable/) + +```bash +pipx install hatch +``` :::{tip} -If you are comfortable using [pipx](https://pipx.pypa.io/stable/) to install hatch, we encourage you to do so. pipx will ensure that your package is available across all of your Python environments on your computer rather than just in the environment that you install it into. +Hatch also provides pre-build binaries available from common OS package managers or directly from +the [hatch website](https://hatch.pypa.io/latest/install/). +::: -However if you are not sure about pipx, you can install hatch using pip or conda. +:::{tip} +Hatch can also be installed directly using `pip` or `conda`, but we encourage you to use `pipx`. +This is because `pipx` will ensure that your package is available across all of your Python +environments on your computer rather than just in the environment that you install it into. +If you install hatch this way you will have to take care that the environment it is installed into +is activated for the command to work. ::: +You can check that hatch is working properly by issuing a simple command to get the version + +```bash +hatch --version +# Hatch, version 1.9.4 +``` + +Note the version numbers will likely be different + ## Configure hatch Once you have installed hatch, you will want to customize the configuration.