Skip to content

Commit

Permalink
update: hatch tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
ucodery committed Apr 7, 2024
1 parent c687681 commit 9773de6
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions tutorials/get-to-know-hatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,35 @@ 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}
Hatch also provides pre-build binaries available from common OS package managers or directly from
the [hatch website](https://hatch.pypa.io/latest/install/).
:::

:::{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 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.

However if you are not sure about pipx, you can install hatch using pip or conda.
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.
Expand Down

0 comments on commit 9773de6

Please sign in to comment.