Skip to content

Fix Python publishing metadata#72

Merged
danielfrankcom merged 2 commits into
mainfrom
dev/frankcom/python-metadata
Jan 30, 2026
Merged

Fix Python publishing metadata#72
danielfrankcom merged 2 commits into
mainfrom
dev/frankcom/python-metadata

Conversation

@danielfrankcom

Copy link
Copy Markdown
Contributor

This PR fixes a few metadata issues for the Python packages in this project, to ensure the data shown on PyPI during publishing is correct.

Currently:

  • The referenced LICENSE file doesn't exist
  • SQLAlchemy uses the old free-form way to specify the license instead of a SPDX identifier
  • The README.md file is not being published for Django (as can be seen in 0.4.0)
  • The other projects reference the README.md in a way that requires full URLs which are hard to maintain and easy to mess up

The change here fixes the licenses for all projects, and uses a hook to update local paths to fully qualified links which will work when clicked from PyPI. The local paths are easier to maintain in the repo, and will work for people with cloned copies in an IDE.

This is conceptually similar to awslabs/aurora-dsql-tortoise-orm#24 but I used a community plugin since I couldn't figure out a simple way to share the hook across the 3 Python packages and didn't want to duplicate the hook code. That is always an option in the future if we can figure out the build issues with parent path references and want to switch.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@danielfrankcom danielfrankcom marked this pull request as ready for review January 30, 2026 20:41
@danielfrankcom danielfrankcom requested a review from a team as a code owner January 30, 2026 20:41
@danielfrankcom danielfrankcom merged commit c2366c0 into main Jan 30, 2026
52 checks passed
@danielfrankcom danielfrankcom deleted the dev/frankcom/python-metadata branch January 30, 2026 20:46
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