How Do I Build a Dynamic README (ctd)?

Skip to article frontmatter Skip to article content

Next, configure the fancy-pypi-readme tool:

pyproject.toml

[tool.hatch.metadata.hooks.fancy-pypi-readme]
content-type = "text/markdown"

Finally, define your readme fragments:

pyproject.toml

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "README.md"
start-after = "<!-- BEGIN README 1 -->"
end-before = "<!-- END README 1 -->"

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
text = "This is a readme\n"

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "README.md"
start-after = "<!-- BEGIN README 2 -->"
end-before = "<!-- END README 2 -->"

Dynamic Metadata

How Do I Build a Dynamic README?

Dynamic Metadata

Conclusion