pyproject-fmt(1)

✨ pyproject-fmt ✨

okay bestie, welcome to pyproject-fmt 💖 — the little glow-up fairy for your pyproject.toml file, straight from the pyproject-fmt(1) manual. she shows up, she reformats, she leaves your config looking ✨immaculate✨.

🌸 NAME 🌸

pyproject-fmt — reformat the given pyproject.toml file. that's it. that's the whole job. and she ate. 💅

🎀 USAGE 🎀

pyproject-fmt [OPTIONS] [PROJECT]

[OPTIONS] = the lil switches you sprinkle on top 🧚 and [PROJECT] is optional, so yeah, you can just run it and let it do its thing.

🦋 DESCRIPTION 🦋

so here's the vibe: pyproject-fmt is designed to reformat the pyproject.toml file you hand it, via the command line. no GUI, no drama, no cap. you point it at a file, it tidies that file up. main character energy, fr fr. 👑

⭐ OPTIONS ⭐

every single one of them, no skipping, iykyk:

• -E, --encoder-class TEXT — the class used to encode the config to TOML. default: pyproject_parser:PyProjectTomlEncoder. yes you can swap her out if you're feeling adventurous 🙈
• -d, --show-diff — show a (coloured) diff of the changes. perfect for when you wanna see exactly what she touched before you commit, bestie 🔥
• --colour / --no-colour — whether to use coloured output. colour on, or no-colour off, your call 💖
• -P, --parser-class TEXT — the class used to parse the pyproject.toml file. default: pyproject_parser:PyProject. she's gotta read it before she can slay it ✨
• -T, --traceback — show the complete traceback on error. for when something goes sideways and you NEED the receipts 😭
• -h, --help — show the help message and exit. the classic. always there for you 🫶

💜 AUTHORS 💜

written by Dominic Davis-Foste <dominic@davis-foster.co.uk> — king behavior 👑

this manual page was written by Josenison F. da Silva <nilsonfsilva@hotmail.com> — iconic, we love a documenter 🎀

and that's the whole page, bestie 🍓 — pyproject-fmt, Jan 2023, manual page pyproject-fmt(1). go forth and make your TOML gorgeous. periodt 💖✨