Your ✨Fancy✨ Project Deserves a ✨Fancy✨ PyPI Readme! 🧐

hatch-fancy-pypi-readme is a Hatch metadata plugin for everyone who cares about the first impression of their project’s PyPI landing page. It allows you to define your PyPI project description in terms of concatenated fragments that are based on static strings, files, and most importantly: parts of files defined using cut-off points or regular expressions.

Once you’ve assembled your readme, you can additionally run regular-expression substitutions over it. For instance to make relative links absolute or to linkify users and issue numbers in your changelog.

Do you want your PyPI readme to be the project readme, but without badges, followed by the license file, and the changelog section for only the last release? You’ve come to the right place!

Note “PyPI project description”, “PyPI landing page”, and “PyPI readme” all refer to the same thing. In setuptools it’s called long_description and is the text shown on a project’s PyPI page. We refer to it as “readme” because that’s how it’s called in PEP 621-based pyproject.toml files.

Showcases

• jsonschema (pyproject.toml)
• pytermgui (pyproject.toml)
• And of course hatch-fancy-pypi-readme itself (pyproject.toml).

Project Links

• License: MIT
• Documentation: https://github.com/hynek/hatch-fancy-pypi-readme#readme
• Changelog: CHANGELOG.md
• PyPI: https://pypi-hypernode.com/project/hatch-fancy-pypi-readme/
• Source Code: https://github.com/hynek/hatch-fancy-pypi-readme
• Supported Python Versions: 3.7 and later (follows Hatch)

Credits

hatch-fancy-pypi-readme is written and maintained by Hynek Schlawack and released under the MIT license.

The development is kindly supported by Variomedia AG and all my amazing GitHub Sponsors.

A full list of contributors can be found on GitHub’s overview.

Release Information for 22.4.0 - 2022-09-10

Added

• It is now possible to run regular expression-based substitutions over the final readme. #9 #11

Full changelog can be found here.