You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorials/1-installable-code.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -156,8 +156,10 @@ Below you will create a directory structure similar to the structure described a
156
156
## Step 1: Set Up the Package Directory Structure
157
157
158
158
* Open your shell or preferred terminal.
159
-
* cd to the location where you'd like your package directory to live. Hatch will create the package directory for you
160
-
* Choose a name for your package, preferably in lowercase and without spaces. For this tutorial we'll use `pyospackage`.
159
+
* Use the shell `cd` command to navigate in your shell to the location where you'd like your package directory to live. Hatch will create the package directory for you
160
+
* Choose a name for your package. The name should:
161
+
* Have no spaces (*Required*)
162
+
* Use all lowercase characters (*Recommended*). For this tutorial we will use `pyospackage`.
161
163
162
164
Next run:
163
165
@@ -293,7 +295,7 @@ You will learn more about the `pyproject.toml` format in the
293
295
[next lesson when you add additional metadata / information to this file.](5-pyproject-toml.md)
294
296
:::
295
297
296
-
- Open up the `pyproject.toml` file that Hatch created in your favorite text editor. Is should look something like the example below.
298
+
- Open up the `pyproject.toml` file that Hatch created in your favorite text editor. It should look something like the example below.
Next, set tests to false in the `[template.plugins.default]` table.
46
46
47
-
While tests are important, setting tests to true will create a more complex pyproject.toml file. That we won't need to use in this beginner friendly tutorial series.
47
+
While tests are important, setting the tests configuration in Hatch
48
+
to `true` will create a more complex pyproject.toml file. You won't
49
+
need to use this feature in this beginner friendly tutorial series
50
+
but we will introduce it in later tutorials.
48
51
49
52
Your config.toml file should look something like the one below. It's ok if you have
50
53
@@ -114,7 +117,7 @@ and maintaining your Python package easier.
114
117
115
118
A few features that hatch offers
116
119
117
-
1. it will convert metadata stored in a setup.py or setup.cfg file to a pyproject.toml file for you. While we haove not extensively tested this feature yet, please let us know if you try it!
120
+
1. it will convert metadata stored in a setup.py or setup.cfg file to a pyproject.toml file for you. While we have not extensively tested this feature yet, please let us know if you try it!
118
121
2. It will help you by storing configuration information for publishing to PyPI after you've entered it once.
119
122
120
123
Use `hatch -h` to see all of the available commands.
0 commit comments