Skip to content

Add complete PyPI project metadata - #556

Open
Yuge Zhang (ultmaster) wants to merge 1 commit into
microsoft:mainfrom
ultmaster:fix/pypi-project-metadata
Open

Add complete PyPI project metadata#556
Yuge Zhang (ultmaster) wants to merge 1 commit into
microsoft:mainfrom
ultmaster:fix/pypi-project-metadata

Conversation

@ultmaster

Copy link
Copy Markdown
Contributor

Summary

  • publish README.md as the PyPI long description
  • add author, SPDX license, keywords, classifiers, and project URLs
  • add regression coverage for the installed distribution metadata

Verification

  • uv lock --check
  • package version and metadata tests
  • Ruff check and format check
  • pre-commit checks for the changed files
  • uv build --no-sources
  • twine check for the wheel and source distribution

Copilot AI lite review requested due to automatic review settings August 22, 2026 02:36
@ultmaster
Yuge Zhang (ultmaster) force-pushed the fix/pypi-project-metadata branch 2 times, most recently from 63b0a00 to 4d171d6 Compare August 22, 2026 02:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the project’s PyPI packaging metadata to provide a richer, more complete published distribution profile, and adds regression tests to validate the installed distribution’s core metadata.

Changes:

  • Publish README.md as the PyPI long description via readme = "README.md".
  • Add richer PEP 621 project metadata (license, author, keywords, classifiers, and project URLs).
  • Add regression coverage asserting key installed distribution metadata fields.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
pyproject.toml Adds PEP 621 project metadata fields (readme/license/authors/keywords/classifiers/URLs) to improve PyPI metadata completeness.
tests/test_package.py Adds installed-distribution metadata assertions to prevent regressions in published package metadata.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread tests/test_package.py Outdated
Comment on lines +20 to +23
assert package_metadata["Author"] == "Microsoft Corporation"
assert package_metadata["Description-Content-Type"] == "text/markdown"
assert package_metadata["License-Expression"] == "MIT"
assert package_metadata.get_payload().startswith('<p align="center">')
Comment thread tests/test_package.py
assert package_metadata["Description-Content-Type"] == "text/markdown"
assert package_metadata["License-Expression"] == "MIT"
assert package_metadata.get_payload().startswith('<p align="center">')
assert set(package_metadata.get_all("Project-URL") or []) == {
Comment thread pyproject.toml
Comment on lines +5 to +7
readme = "README.md"
license = "MIT"
authors = [
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