# hatch-fancy-pypi-readme

> Fancy PyPI READMEs with Hatch

- **URL**: https://www.freshcrate.ai/projects/hatch-fancy-pypi-readme
- **Author**: pypi
- **Category**: Frameworks
- **Latest version**: `25.1.0` (2026-04-21)
- **License**: Unknown
- **Source**: https://github.com/hynek/hatch-fancy-pypi-readme/blob/main/CHANGELOG.md
- **Homepage**: https://pypi.org/project/hatch-fancy-pypi-readme/
- **Language**: Python
- **GitHub**: 187 stars, 10 forks
- **Registry**: pypi (`hatch-fancy-pypi-readme`)
- **Tags**: `documentation`, `hatch`, `pypi`, `readme`

## Description

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

*hatch-fancy-pypi-readme* is an MIT-licensed metadata plugin for [Hatch](https://hatch.pypa.io/) by [Hynek Schlawack](https://hynek.me/).

Its purpose is to help you to have fancy PyPI readmes – unlike *this* one you’re looking at right now.

Please check out the [documentation](https://github.com/hynek/hatch-fancy-pypi-readme#readme) to see what *hatch-fancy-pypi-readme* can do for you and your projects!

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `25.1.0` | 2026-04-21 | Low | Imported from PyPI (25.1.0) |
| `24.1.0` | 2024-01-01 | Low | ## Highlights  The last release [broke _scikit-build-core_](https://github.com/scikit-build/scikit-build-core/issues/592) so this one adds a default argument value. No user-visible changes.   ## Special Thanks  This release would not be possible without my generous sponsors! Thank you to all of you making sustainable maintenance possible! If *you* would like to join them, go to <https://github.com/sponsors/hynek> and check out the sweet perks!   ### Above and Beyond  [Variomedia AG]( |
| `23.2.0` | 2023-12-31 | Low | ## Highlights  There's only one change but I think it's really cool: you can now add the package version into your PyPI readme by adding the string `$HFPR_VERSION` to it!   ## Special Thanks  This release would not be possible without my generous sponsors! Thank you to all of you making sustainable maintenance possible! If *you* would like to join them, go to <https://github.com/sponsors/hynek> and check out the sweet perks!   ### Above and Beyond  [Variomedia AG](https://www.variome |
| `23.1.0` | 2023-05-22 | Low | The only change is that our CLI [now](https://github.com/hynek/hatch-fancy-pypi-readme/pull/27) also takes the presence of an `hatch.toml` file into account.  The packaging side always supported it. |
| `22.8.0` | 2022-10-02 | Low | The only change is a new feature for file fragments: `start-at` which behaves like `start-after`, but preserves the string that is searched for.  Here's [a real-world example](https://github.com/hynek/stamina/commit/3091be412d5ff0ffa7c43c261e34a532de7a5a71) of how it can simplify your configuration.   **Full Changelog**: https://github.com/hynek/hatch-fancy-pypi-readme/compare/22.7.0...22.8.0 |
| `22.7.0` | 2022-09-12 | Low | Removed another circular dependency: this time the wonderful [jsonschema](https://python-jsonschema.readthedocs.io/). The price of building packaging tools is to not use packages.  No changes in functionality. |
| `22.6.0` | 2022-09-11 | Low | There's no changes in this version except that we've returned to a static readme to prevent a circular build dependency and make the life of packagers easier: [#13](https://github.com/hynek/hatch-fancy-pypi-readme/issues/13) |
| `22.5.0` | 2022-09-10 | Low | Substitutions!  Many projects use their `setup.py` to do some searching andreplacing using regular expressions. For example to make GitHub-relative links work on PyPI, or to linkify GitHub user names and issue/pull request numbers.  [Now you can do that with *hatch-fancy-pypi-readme* too](https://github.com/hynek/hatch-fancy-pypi-readme#substitutions)!  That change actually landed already in 22.4.0, but I couldn't wait to use it myself – [so here we go](https://pypi.org/project/hatch-fancy |
| `22.3.0` | 2022-08-06 | Low | ### Added  - Support for Python 3.7.   While our Python version only applies when building a package, a package is built whenever it is installed. This includes *tox* environments. *hatch-fancy-pypi-readme* will always *at least* support the same Python version as the latest version of *Hatchling* – *Hatch*'s build backend – does.    To get this version out, we had to stop dog-fooding *hatch-fancy-pypi-readme*. 😢 |
| `22.2.0` | 2022-08-05 | Low | ### Changed  - We can finally use *hatch-fancy-pypi-readme* for our own ✨fancy✨ PyPI readme!   ### Fixed  - Hopefully fixed readmes with emojis on Windows. |

## Citation

- HTML: https://www.freshcrate.ai/projects/hatch-fancy-pypi-readme
- Markdown: https://www.freshcrate.ai/projects/hatch-fancy-pypi-readme.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/hatch-fancy-pypi-readme/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._