hatch-fancy-pypi-readme
Fancy PyPI READMEs with Hatch
Decision gist · record as of 2026-08-14
Yes. This is a stable, actively maintained plugin with low install friction and no security issues. Install it if you use Hatch and want to compose your PyPI readme from multiple sources or apply transformations without manual editing. Skip it only if you're satisfied with a static readme file or not using Hatch.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Hatch as your build backend; only works with pyproject.toml-based projects.
- Low friction install with only two runtime dependencies (hatchling and tomli).
- Active maintenance with a recent release in 2025 and steady commit activity; no known vulnerabilities.
License · maintenance · safety
MIT (permissive) — MIT license permits unrestricted use, modification, and distribution with minimal obligations—suitable for any project type.
last release 2025-05-01 (470 days) · last repo commit 2026-08-04 · 189 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 7,632,891 downloads/mo, #1,711 on PyPI
Alternatives
Verify before relying
# In pyproject.toml:
[build-system]
requires = ["hatchling", "hatch-fancy-pypi-readme"]
build-backend = "hatchling.build"
[project]
dynamic = ["readme"]
[tool.hatch.metadata.hooks.fancy-pypi-readme]
content-type = "text/markdown"
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
text = "# My Project"
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "README.md"- Whether regex substitutions support all standard Python re module flags and features beyond DOTALL.
- Performance characteristics when assembling very large readmes from many fragments or large files.
- Whether file paths are resolved relative to the project root or the pyproject.toml location.
What it is and what it does
hatch-fancy-pypi-readme is a Hatch metadata plugin that lets you build your PyPI project description dynamically from reusable fragments. Instead of maintaining a single static readme or long_description, you define an ordered list of fragments in your pyproject.toml—each can be plain text, a whole file, or a slice of a file extracted using cut-off points or regex patterns. After assembly, you can run regex-based substitutions across the entire readme to fix relative links, linkify issue numbers, or make other global transformations.
It solves the common problem of wanting your PyPI readme to differ from your GitHub readme (e.g., without badges, with only the latest changelog section, or with absolute links). You configure it once in pyproject.toml and the plugin generates the readme at build time, eliminating the need for manual synchronization or complex setup.py logic.
Use it for
- Assemble a PyPI readme from your main README minus badges, plus your LICENSE file and the latest release notes from CHANGELOG.
- Extract and display only the most recent version's changes from a changelog file using regex pattern matching.
- Automatically convert relative GitHub links to absolute PyPI-safe URLs via regex substitution across the final readme.
- Maintain separate documentation for GitHub (with badges and development notes) and PyPI (user-focused) without duplication.
- Build a readme that includes snippets from multiple source files, each trimmed to specific sections using start/end markers.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
This is a stable, actively maintained plugin with low install friction and no security issues. Install it if you use Hatch and want to compose your PyPI readme from multiple sources or apply transformations without manual editing. Skip it only if you're satisfied with a static readme file or not using Hatch.
Install
hatch-fancy-pypi-readme on PyPI
Before you install
Low friction install with only two runtime dependencies (hatchling and tomli). Active maintenance with a recent release in 2025 and steady commit activity; no known vulnerabilities.
Requires Hatch as your build backend; only works with pyproject.toml-based projects.
License in practice
MIT license permits unrestricted use, modification, and distribution with minimal obligations—suitable for any project type.
Quickstart
# In pyproject.toml:
[build-system]
requires = ["hatchling", "hatch-fancy-pypi-readme"]
build-backend = "hatchling.build"
[project]
dynamic = ["readme"]
[tool.hatch.metadata.hooks.fancy-pypi-readme]
content-type = "text/markdown"
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
text = "# My Project"
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "README.md"Verify before relying
- Whether regex substitutions support all standard Python re module flags and features beyond DOTALL.
- Performance characteristics when assembling very large readmes from many fragments or large files.
- Whether file paths are resolved relative to the project root or the pyproject.toml location.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packageshatchlingtomli |
| Maintenance | Actively maintained 470 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 7,632,891 / month, #1,711 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: HatchOperating System :: OS IndependentProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: Software Development :: Build Tools |
Evidence: hatch_fancy_pypi_readme-25.1.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “dynamic pypi readme generation”
- hatch-fancy-pypi-readmeA Hatch plugin that generates dynamic PyPI project descriptions by…
- readme-rendererSafely renders README files in Markdown, reStructuredText, and plain…
- collective.checkdocsAdds distutils commands to validate and preview reStructuredText in a…
Give your agent the search over MCP, or paste the wish link into any chat.
More Build Tools packages
Provides reusable utilities for Python packaging interoperability, including version handling, specifiers, markers, requirements, tags, and metadata parsing according to standards like PEP 440 and PEP 425.
Wraps any iterable to display a real-time progress bar in the terminal or Jupyter notebook, showing iteration count, elapsed time, and estimated time remaining.
pip is the standard installer for Python packages, enabling you to download and install packages from the Python Package Index and other indexes into your Python environment.
Hatchling is a standards-compliant Python build backend that handles packaging, metadata, and distribution of Python projects when configured in a project's pyproject.toml file.
Generates Python gRPC service stubs and message classes from Protocol Buffer definitions, enabling developers to build gRPC clients and servers.
pre-commit is a framework for installing and running git hooks written in any language before commits are made, automating code quality and validation checks across multi-language projects.
Install it if your team needs consistent, automated validation at commit time.
See also hatch-requirements-txt · hatch_build_scripts · hatch-nodejs-version · hatch-regex-commit · hatch-polylith-bricks · hatch-vcs · hatch-cython · hatchling-autoextras-hook · towncrier