hatch-fancy-pypi-readme

# 1. Create a project directory, e.g., 'my_fancy_package' # 2. Inside 'my_fancy_package', create these files: # pyproject.toml # -------------------------------------------------- # [build-system] # requires = ["hatchling>=1.18.0", "hatch-fancy-pypi-readme==25.1.0"] # build-backend = "hatchling.build" # # [project] # name = "my-fancy-package" # version = "0.1.0" # description = "A package with a fancy README" # authors = [{ name = "Agent", email = "agent@example.com" }] # readme = { file = "README.md", content-type = "text/markdown", checker = "fancy" } # # [tool.hatch.build.targets.sdist.hooks.fancy-pypi-readme] # files = ["README.md", "CHANGELOG.md"] # template = "# {{ project.name }} - v{{ project.version }}\n\n" \ # "## Main README\n{{ files['README.md'] }}\n\n" \ # "## Changelog\n{{ files['CHANGELOG.md'] }}" # -------------------------------------------------- # README.md # -------------------------------------------------- # This is the primary README content for my package. # It will be combined with other files by hatch-fancy-pypi-readme. # -------------------------------------------------- # CHANGELOG.md # -------------------------------------------------- # ### 0.1.0 # - Initial release with fancy README generation. # - Added support for combining README and CHANGELOG. # -------------------------------------------------- # 3. Navigate to the 'my_fancy_package' directory in your terminal. # 4. Run the build command: # hatch build # After building, you will find the generated sdist and wheel files # in the 'dist/' directory, with the README correctly templated.