PYROMA(1)

📦 version 5.0.1, in debian bookworm, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ PYROMA(1) ✨

ok so bestie, welcome to the General Commands Manual 💖 this one's about pyroma, and honestly? it's giving quality control but make it cute. let's get into it 🫶

🌸 NAME 🌸

pyroma — a Python packaging quality checker. yes, it literally rates your packaging vibes. 💅

🦋 SYNOPSIS 🦋

pyroma [-d <directory>|-f <file>|-p <package>]

like, pick ONE of those three modes, okay? the vibes do not overlap here. ✨

🎀 DESCRIPTION 🎀

okay so, pyroma / pyroma3 is a program that hands out a rating of how well your Python project is following the best practices of the Python packaging ecosystem. we're talking primarily PyPI, pip, Distribute etc. 👑

and it doesn't just give you a number and ghost you — nope, it also gives you a list of issues that could be improved. constructive criticism, but make it slay. 💅

it can check packages locally and on PyPI. so whether your stuff is sitting on your laptop or living its best life out on the index, pyroma will find it and give it a vibe check. 🔥

💖 OPTIONS 💖

  • -h, --help — shows you a summary of the options. the classic "help me help you" move. 🙈
  • -a, --auto — selects the mode automatically. this is the default, so if you don't say anything, pyroma just handles it. main character energy, honestly. ✨
  • -d, --directory <project directory> — runs pyroma on a module inside a project directory. local file besties, this one's for you. 🍓
  • -f, --file <distribution file> — runs pyroma on a distribution file. yes, the actual distribution file. it will judge it (lovingly). 📦
  • -p, --pypi <PyPI package name> — runs pyroma on a package that lives on PyPI. just name it and it goes and finds it. 🧚
more detailed documentation is available at https://bitbucket.org/regebro/pyroma — go read it if you want the full lore, iykyk. 💜

👑 AUTHOR 👑

Pyroma was written by Lennart Regebro <regebro@gmail.com> 🌈

this manual page was written by Federico Ceratto <federico.ceratto@gmail.com> for the Debian project, and may be used by others. 🫶

and that's the whole page, bestie!! this was the PYROMA(1) manpage, General Commands Manual edition, dated April 7, 2014 — yeah it's an oldie but she still ate 💅⭐ go rate some packaging, no cap. 💖

📦 where this page comes from