HATCH-FANCY-PYPI-README(1)

πŸ’– HATCH-FANCY-PYPI-README πŸ’–

okay so bestie, welcome to the <rainbow>hatch-fancy-pypi-readme</rainbow> era β€” this is the manual page for it, and yes it's giving main character energy ✨


✨ NAME ✨

hatch-fancy-pypi-readme β€” render Python project README πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

hatch-fancy-pypi-readme [options] [PATH]

🌸 DESCRIPTION 🌸

So like, hatch-fancy-pypi-readme is a CLI tool that lets you manually render your project's README, exactly the way it's defined in pyproject.toml and hatch.toml. no cap. 🫢

Normally though? The render process just gets invoked as part of the hatchling build. like it happens automatically, you don't even have to think about it. but sometimes you wanna run it yourself, and that's what this is for. periodt. πŸ’…

The following options are recognized:

  • PATH β€” the path to the pyproject.toml of your project. If you omit it, the current directory is used. simple as that ✨
  • -o OUTPUT β€” write the result to OUTPUT. If you omit it, the results go to stdout instead. your choice bestie πŸŽ€
  • --hatch-toml FILE β€” read an additional hatch.toml for rendering options. extra config, extra vibes 🌈

πŸ“œ MANUAL PAGE πŸ“œ

This manual page was written for the Debian distribution by Timo RΓΆhling, and may be used without restriction. (iconic of him honestly πŸ‘‘)


and that's the whole thing! thanks for reading the HATCH-FANCY-PYPI-README(1) manual page bestie, it's the same name at the top and the bottom because that's just how manpages do πŸ’– mwah, go render something gorgeous πŸŒΈπŸ’…βœ¨