Skip to article frontmatterSkip to article content

How Do I Build a Dynamic README?

First, add hatch-fancy-pypi-readme to your [build-system] table:

pyproject.toml
[build-system]
requires = ["hatchling", "hatch-fancy-pypi-readme"]
build-backend = "hatchling.build"

Then tell hatchling about the dynamic readme and remove the readme field:

pyproject.toml
[project]
dynamic = ["version", "readme"]