-
Notifications
You must be signed in to change notification settings - Fork 586
Description
The Spec
The project description from the pyproject.toml
, per https://packaging.python.org/en/latest/specifications/pyproject-toml/#description:
Corresponding core metadata field: Summary
The summary description of the project in one line. Tools MAY error if this includes multiple lines.
And the core metadata "Summary", per https://packaging.python.org/en/latest/specifications/core-metadata/#summary should be:
A one-line summary of what the distribution does.
The Problem
This does indeed cause tools to error, particularly the GitLab package index. See https://gitlab.com/gitlab-org/gitlab/-/issues/440402, https://gitlab.com/gitlab-org/gitlab/-/issues/444304, etc. While GitLab's max length constraint could be to blame, the summary is excessively long and does not meet the intent of the metadata field.
The Solution
I think the project description in the pyproject.toml
should only be the first sentence. The additional information is not necessary for such a high-level statement, and can go in the long_description or README if desired.