Skip to content

Commit 2c16c62

Browse files
authored
Fix: consistency edits from @ptressel
Update get-to-know-hatch.md for consistent style of "Hatch" etc.
2 parents 37a8d5e + 0b18289 commit 2c16c62

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

tutorials/get-to-know-hatch.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Get to know hatch
1+
# Get to know Hatch
22

33
Our Python packaging tutorials use the tool Hatch.
4-
In this tutorial, you will install and get to know hatch a bit more before starting to use it.
4+
In this tutorial, you will install and get to know Hatch a bit more before starting to use it.
55

66
## Install Hatch
77
To begin, install Hatch from the command line using [pipx](https://pipx.pypa.io/stable/)
@@ -10,11 +10,6 @@ To begin, install Hatch from the command line using [pipx](https://pipx.pypa.io/
1010
pipx install hatch
1111
```
1212

13-
:::{tip}
14-
Hatch also provides pre-build binaries available from common OS package managers or directly from
15-
the [hatch website](https://hatch.pypa.io/latest/install/).
16-
:::
17-
1813
:::{tip}
1914
Hatch can also be installed directly using `pip` or `conda`, but we encourage you to use `pipx`.
2015
This is because `pipx` will ensure that your package is available across all of your Python
@@ -34,24 +29,24 @@ Note the version numbers will likely be different
3429

3530
## Configure hatch
3631

37-
Once you have installed hatch, you will want to customize the configuration.
32+
Once you have installed Hatch, you will want to customize the configuration.
3833

39-
Hatch stores your configuration information in a [config.toml file](https://hatch.pypa.io/latest/config/project-templates/).
34+
Hatch stores your configuration information in a [`config.toml` file](https://.pypa.io/latest/config/project-templates/).
4035

4136
While you can update the `config.toml` file through the command line,
4237
it might be easier to look at it and update it in a text editor if you are using it for the first time.
4338

44-
### Step 1: Open and edit your config.toml file
39+
### Step 1: Open and edit your `config.toml` file
4540

4641
To open the config file in your file browser, run the following command in your shell:
4742

4843
`hatch config explore`
4944

50-
This will open up a directory window that will allow you to double click on the file and open it in your favorite text editor
45+
This will open up a directory window that will allow you to double click on the file and open it in your favorite text editor.
5146

5247
### Step 2 - update your email and name
5348

54-
Once the file is open, update the [template] table of the config.toml file with your name and email. This information will be used in any pyproject.toml metadata files that you create using hatch.
49+
Once the file is open, update the [template] table of the `config.toml` file with your name and email. This information will be used in any `pyproject.toml` metadata files that you create using Hatch.
5550

5651
```toml
5752
[template]
@@ -64,7 +59,7 @@ email = "your-email@your-domain.org"
6459
Next, set tests to false in the `[template.plugins.default]` table.
6560

6661
While tests are important, setting the tests configuration in Hatch
67-
to `true` will create a more complex pyproject.toml file. You won't
62+
to `true` will create a more complex `pyproject.toml` file. You won't
6863
need to use this feature in this beginner friendly tutorial series
6964
but we will introduce it in later tutorials.
7065

@@ -111,19 +106,19 @@ license in more detail in a later lesson, the MIT license is the
111106
recommended permissive license from [choosealicense.com](https://www.choosealicense.com) and as such we will
112107
use it for this tutorial series.
113108

114-
You are of course welcome to select another license
109+
You are of course welcome to select another license.
115110

116111
:::{todo}
117112
I think we'd need the SPDX license options here if they want to chose bsd-3 for instance
118113
:::
119114

120-
### Step 4: Close the config file and run hatch config show
115+
### Step 4: Close the config file and run `hatch config show`
121116

122117
Once you have completed the steps above run the following command in your shell.
123118

124119
`hatch config show`
125120

126-
hatch config show will print out the contents of your config.toml file in your shell. look at the values and ensure that your name, email is set. Also make sure that tests=false.
121+
`hatch config show` will print out the contents of your `config.toml` file in your shell. look at the values and ensure that your name, email is set. Also make sure that `tests=false`.
127122

128123
## Hatch features
129124

@@ -132,12 +127,13 @@ and maintaining your Python package easier.
132127

133128
:::{admonition} Comparison to other tools
134129
:class: tip
135-
[We compared hatch to several of the other popular packaging tools in the ecosystem including flit, pdm and poetry. Learn more here](package-features)
130+
[We compared Hatch to several of the other popular packaging tools in the ecosystem including flit, pdm and poetry. Learn more here](package-features)
136131
:::
137132

138-
[More on hatch here](hatch)
133+
[More on Hatch here](hatch)
134+
135+
A few features that Hatch offers
139136

140-
A few features that hatch offers
141137

142138
1. it will convert metadata stored in a `setup.py` or `setup.cfg` file to a pyproject.toml file for you (see [Migrating setup.py to pyproject.toml using Hatch](setup-py-to-pyproject-toml.md
143139
))

0 commit comments

Comments
 (0)