Skip to content

Conversation

@paddyroddy
Copy link
Member

@paddyroddy paddyroddy commented Dec 23, 2025

Description

This PR uses the fancy-pypi-readme package to do the stable replacement in documentation links on PyPI. I have tested this locally and the generated METADATA file follows the desired format. This allows us to simplify the README format.

I've also made the link format more consistent in the README.

I also did a workflow_dispatch, the logs appear to have worked. The TestPyPI action has failed, needs some config on your end @ntessore?
logs_52895020779.zip

Closes: #433

Checks

  • Is your code passing linting?
  • Is your code passing tests?
  • Have you added additional tests (if required)?
  • Have you modified/extended the documentation (if required)?
  • Have you added a one-liner changelog entry above (if required)?

@paddyroddy paddyroddy self-assigned this Dec 23, 2025
@paddyroddy paddyroddy added enhancement New feature or request infrastructure Project infrastructure: dev tools, packaging, etc. labels Dec 23, 2025
Comment on lines +133 to +134
[tool.hatch.metadata.hooks.fancy-pypi-readme]
content-type = "text/markdown"
Copy link
Member Author

Choose a reason for hiding this comment

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

Sadly, this doesn't seem to work if I put it in [tool.hatch] as metadata.hooks.fancy-pypi-readme.content-type = "text/markdown".

Comment on lines +278 to +281
overrides."tool.hatch".first = [
"build",
"version",
]
Copy link
Member Author

Choose a reason for hiding this comment

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

This is frustrating, something to do with TOML array of tables. Same thing discussed in pappasam/toml-sort#94.

@paddyroddy paddyroddy removed the needs-2-reviewers Could be considered "controversial" so worth a second pair of eyes label Jan 6, 2026
@paddyroddy paddyroddy merged commit 5857817 into main Jan 6, 2026
13 of 15 checks passed
@paddyroddy paddyroddy deleted the paddy/issue-433 branch January 6, 2026 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request infrastructure Project infrastructure: dev tools, packaging, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Modify README as part of build process rather than using SETUPTOOLS_SCM_PRETEND_VERSION

3 participants