Skip to content

Optimize PyPI package presentation metadata#2

Merged
PythonFZ merged 4 commits into
design/rfc9457from
copilot/pypi-release-optimisation
Jun 18, 2026
Merged

Optimize PyPI package presentation metadata#2
PythonFZ merged 4 commits into
design/rfc9457from
copilot/pypi-release-optimisation

Conversation

Copilot AI commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

This PR addresses PyPI release polish gaps: missing project URLs and license artifact metadata, unresolved README images on PyPI, and absence of a PyPI badge.

  • Packaging metadata (pyproject.toml)

    • Added missing [project.urls] entries:
      • Repository
      • Releases
    • Included LICENSE in sdist include list so source distributions ship license text.
  • Repository licensing

    • Added top-level LICENSE file (MIT) to align with declared project license metadata.
  • README PyPI rendering

    • Added a PyPI version badge.
    • Converted README image links from relative paths to absolute GitHub raw URLs so images render correctly on PyPI.
  • Regression coverage

    • Added focused tests (tests/test_packaging_metadata.py) to assert:
      • required project.urls keys exist,
      • README contains PyPI badge,
      • README image links are absolute (not local docs/img/... paths),
      • LICENSE file is present.
[project.urls]
Repository = "https://github.com/PythonFZ/fastapi-rfc9457"
Releases = "https://github.com/PythonFZ/fastapi-rfc9457/releases"

Copilot AI changed the title [WIP] Optimize PyPI release by fixing image paths and adding metadata Optimize PyPI package presentation metadata Jun 18, 2026
Copilot AI requested a review from PythonFZ June 18, 2026 16:31

@PythonFZ PythonFZ left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@PythonFZ PythonFZ marked this pull request as ready for review June 18, 2026 16:36
@PythonFZ PythonFZ merged commit 97ba4c3 into design/rfc9457 Jun 18, 2026
3 of 4 checks passed
@PythonFZ PythonFZ deleted the copilot/pypi-release-optimisation branch June 18, 2026 16:37
PythonFZ added a commit that referenced this pull request Jun 18, 2026
* Initial plan

* Optimize PyPI release metadata and README assets

* Delete tests/test_packaging_metadata.py

* Update README with dereferenceable type URIs section

Add section on dereferenceable type URIs in README.

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants