-
Notifications
You must be signed in to change notification settings - Fork 928
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.
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
pyproject.toml - "Bug Tracker" example is not best #1183
Comments
I think it may be a good idea to decide on a canonical set of labels for the common |
"Bug tracker" is Issues now; this issue should be closed. (Standardizing the keys would probably require a PEP and is way beyond the scope of this issue tracker.) |
Root of this: PyPi uses key names as human readable link text. (maybe fine, maybe not, but not what this is about.)
This issue is about:
This example in packaging tutorials is valid but not best:
"Bug Tracker" = "https://github.com/pypa/sampleproject/issues"
https://packaging.python.org/en/latest/tutorials/packaging-projects/#configuring-metadata
Toml spec says:
Quoted keys follow the exact same rules as either basic strings or literal strings and allow you to use a much broader set of key names. Best practice is to use bare keys except when absolutely necessary.
https://toml.io/en/v1.0.0#keys
Packaging docs:
https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#urls
The use case for quoted keys is: pretty link text on PyPi.
Here is an example in the wild:
https://pypi.org/project/ddb-cache/
There are 2 ways of making the example better:
The text was updated successfully, but these errors were encountered: