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/pyproject-toml.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -154,7 +154,7 @@ help users find your package on PyPI and also better describe the scope of your
154
154
The documentation for the hatchling back-end is [here](https://hatch.pypa.io/latest/config/metadata/)
155
155
:::
156
156
157
-
### Step 1: Populate the [project] table with author, maintainer and project description
157
+
### Step 1: Add Author, maintainer and project description
158
158
159
159
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.
160
160
@@ -232,7 +232,7 @@ However, we encourage you to consider carefully, for PyPI publication, who
232
232
you want to have listed as authors and maintainers on your PyPI landing page.
233
233
:::
234
234
235
-
### Step 2: Link your README and license in your pyproject.toml file
235
+
### Step 2: Add README and license
236
236
237
237
In the previous lessons, you added both a [README.md](add-readme) file and a [LICENSE](add-license-coc) to your package repository.
238
238
Once you have those files, you can add them to your pyproject.toml file as
### Step 3: Add requires-python to your [project] table
256
+
### Step 3: Specify Python version with `requires-python`
257
257
258
258
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.
259
259
@@ -275,7 +275,7 @@ license = {file = 'LICENSE'}
275
275
requires-python = ">=3.10"
276
276
```
277
277
278
-
### Step 4: Add package dependencies to your [project] table
278
+
### Step 4: Specify Dependencies
279
279
280
280
Next add your dependencies table to the project table.
281
281
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.
331
331
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)
332
332
:::
333
333
334
-
### Step 5: Add PyPI classifiers to your pyproject.toml file
334
+
### Step 5: Add PyPI classifiers
335
335
336
336
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.
0 commit comments