Add clarification about PyPI package name source#615
Open
M-Nagamani wants to merge 2 commits intopyOpenSci:mainfrom
Open
Add clarification about PyPI package name source#615M-Nagamani wants to merge 2 commits intopyOpenSci:mainfrom
M-Nagamani wants to merge 2 commits intopyOpenSci:mainfrom
Conversation
Adds a short explanation clarifying that the package name used by PyPI is defined in `pyproject.toml`. This helps explain why a package may need to be renamed if the name is already taken.
sneakers-the-rat
approved these changes
Mar 12, 2026
willingc
reviewed
Mar 12, 2026
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Author
|
Thanks for the suggestion! I've updated the text accordingly. |
willingc
reviewed
Mar 20, 2026
|
|
||
| Before renaming your package, it helps to understand where the PyPI package name comes from. The name that PyPI registers is defined in the `pyproject.toml` file under the `[project]` section. This name does not have to match your GitHub repository name, but many projects keep them the same for clarity. | ||
|
|
||
| If the name in `pyproject.toml` is already taken on PyPI, you will need to choose a different name before publishing. |
Collaborator
There was a problem hiding this comment.
Suggested change
| If the name in `pyproject.toml` is already taken on PyPI, you will need to choose a different name before publishing. | |
| If the name in `pyproject.toml` is already taken on PyPI, you will need to choose a different name before publishing. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a short explanation clarifying that the package name used by PyPI is defined in
pyproject.toml. This helps explain why a package may need to be renamed if the name is already taken.Fixes #244