Skip to content

Commit 1fab12c

Browse files
authored
Fix: Concise headings in tutorials/pyproject-toml.md
2 parents 1191048 + 6f768f5 commit 1fab12c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

tutorials/pyproject-toml.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ help users find your package on PyPI and also better describe the scope of your
154154
The documentation for the hatchling back-end is [here](https://hatch.pypa.io/latest/config/metadata/)
155155
:::
156156

157-
### Step 1: Populate the [project] table with author, maintainer and project description
157+
### Step 1: Add Author, maintainer and project description
158158

159159
After completing the [installable code tutorial](1-installable-code), you should have a pyproject.toml file with a project name and a version in the `[project]` table.
160160

@@ -232,7 +232,7 @@ However, we encourage you to consider carefully, for PyPI publication, who
232232
you want to have listed as authors and maintainers on your PyPI landing page.
233233
:::
234234

235-
### Step 2: Link your README and license in your pyproject.toml file
235+
### Step 2: Add README and license
236236

237237
In the previous lessons, you added both a [README.md](add-readme) file and a [LICENSE](add-license-coc) to your package repository.
238238
Once you have those files, you can add them to your pyproject.toml file as
@@ -253,7 +253,7 @@ maintainers = [{ name = "Firstname lastname", email = "email@pyopensci.org" }, {
253253
readme = "README.md"
254254
license = {file = 'LICENSE'}
255255
```
256-
### Step 3: Add requires-python to your [project] table
256+
### Step 3: Specify Python version with `requires-python`
257257

258258
Finally, add the `requires-python` field to your `pyproject.toml` `[project]` table. The `requires-python` field, helps pip understand the lowest version of Python that you package supports when it's installed. It is thus a single value.
259259

@@ -275,7 +275,7 @@ license = {file = 'LICENSE'}
275275
requires-python = ">=3.10"
276276
```
277277

278-
### Step 4: Add package dependencies to your [project] table
278+
### Step 4: Specify Dependencies
279279

280280
Next add your dependencies table to the project table.
281281
The `dependencies =` section contains a list (or array in the toml language) of the Python packages that your package requires to run properly in a Python environment. Similar to the requirements listed in the `[build-system]` table above:
@@ -331,7 +331,7 @@ do so.
331331
One build tool that you should be aware of that pins dependencies to an upper bound by default is Poetry. [Read more about how to safely add dependencies with Poetry, here.](../package-structure-code/python-package-build-tools.html#challenges-with-poetry)
332332
:::
333333

334-
### Step 5: Add PyPI classifiers to your pyproject.toml file
334+
### Step 5: Add PyPI classifiers
335335

336336
Next you will add classifiers to your `pyproject.toml` file. The value for each classifier that you add to your `pyproject.toml` file must come from the list of [PyPI accepted classifier values found here](https://PyPI.org/classifiers/). Any deviations in spelling and format will cause issues when you publish to PyPI.
337337

0 commit comments

Comments
 (0)