freshcrate
Home > Frameworks > hatch-fancy-pypi-readme

hatch-fancy-pypi-readme

Fancy PyPI READMEs with Hatch

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!

Release History

VersionChangesUrgencyDate
25.1.0Imported from PyPI (25.1.0)Low4/21/2026
24.1.0## 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](Low1/1/2024
23.2.0## 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.variomeLow12/31/2023
23.1.0The 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.Low5/22/2023
22.8.0The 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.0Low10/2/2022
22.7.0Removed 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.Low9/12/2022
22.6.0There'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)Low9/11/2022
22.5.0Substitutions! 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-fancyLow9/10/2022
22.3.0### 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*. 😒Low8/6/2022
22.2.0### Changed - We can finally use *hatch-fancy-pypi-readme* for our own ✨fancy✨ PyPI readme! ### Fixed - Hopefully fixed readmes with emojis on Windows.Low8/5/2022
22.1.0### Added - Initial release. Low8/5/2022

Dependencies & License Audit

Loading dependencies...

Similar Packages

drf-yasgAutomated generation of real Swagger/OpenAPI 2.0 schemas from Django Rest Framework code.1.21.15
uv-dynamic-versioningDynamic versioning based on VCS tags for uv/hatch project0.14.0
mkdocs-materialDocumentation that simply works9.7.6
pre-commitA framework for managing and maintaining multi-language pre-commit hooks.v4.6.0
azure-core-tracing-opentelemetryMicrosoft Azure Azure Core OpenTelemetry plugin Library for Pythonazure-template_0.1.0b6187637