Skip to content

docs: use well-known project URL labels in the pyproject.toml tutorial #823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
InessaPawson merged 2 commits into from
Oct 13, 2026
Merged

docs: use well-known project URL labels in the pyproject.toml tutorial #823

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35c50e2
docs: use well-known project URL labels in the pyproject.toml tutorial
simonvanlierde Oct 13, 2026
c8cc64b
docs: clarify the Homepage label
InessaPawson Oct 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions tutorials/pyproject-toml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,10 +502,12 @@ Finally, add the project.urls table to your pyproject.toml file.

`project.urls` contains links that are relevant for your project. You might want to include:

- **Homepage:** A link to your published documentation for your project. If you are working through this tutorial, then you may not have this link yet. That's ok, you can skip it for the time being.
- **Bug reports:** a link to your issues/discussions or wherever you want users to report bugs.
- **Homepage:** A link to your project’s website. For many packages this is often the documentation site. If you are working through this tutorial, then you may not have this link yet. That's ok, you can skip it for the time being.
- **Issues:** a link to your issues/discussions or wherever you want users to report bugs.
- **Source:** the GitHub / GitLab link for your project.

These three names are on the PyPA list of [well-known project URL labels](https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels). The list lets package indexes such as PyPI present project URLs in a consistent way, so pick a label from it when one fits.

{emphasize-lines="34-37"}
```toml
[build-system]
Expand Down Expand Up @@ -543,12 +545,12 @@ classifiers = [

[project.urls] # Optional
"Homepage" = "https://www.pyopensci.org"
"Bug Reports" = "https://github.com/pyopensci/pyosmeta/issues"
"Issues" = "https://github.com/pyopensci/pyosmeta/issues"
"Source" = "https://github.com/pyopensci/pyosmeta/"
```

:::{tip}
There are many other urls that you can add here. Check out the [README file here for an overview](https://github.com/patrick91/links-demo).
There are many other urls that you can add here, such as `Documentation`, `Changelog` or `Funding` from the same list. Check out the [README file here for an overview](https://github.com/patrick91/links-demo).
:::

## Putting it all together - your completed pyproject.toml file
Expand Down Expand Up @@ -592,7 +594,7 @@ classifiers = [

[project.urls] # Optional
"Homepage" = "https://www.pyopensci.org"
"Bug Reports" = "https://github.com/pyopensci/pyosmeta/issues"
"Issues" = "https://github.com/pyopensci/pyosmeta/issues"
"Source" = "https://github.com/pyopensci/pyosmeta/"
```

Expand Down Expand Up @@ -660,7 +662,7 @@ license = "MIT"
# Add urls for your home page, issue tracker and source code
[project.urls] # Optional
"Homepage" = "https://www.pyopensci.org"
"Bug Reports" = "https://github.com/pyopensci/pyospackage/issues"
"Issues" = "https://github.com/pyopensci/pyospackage/issues"
#"Funding" = ""
"Source" = "https://github.com/pyopensci/pyospackage"
```
Expand Down
Loading