RADON(1)

💖 radon — the manual page, but make it cute 💖

okay bestie, welcome to the radon page (that's section 1 of the manual, iykyk) ✨ this is the whole thing, every single flag, no skips, no cap 🫶

✨ NAME ✨

radon — Python tool to compute code metrics 💅

---

🦋 DESCRIPTION 🦋

okay so radon is a Python tool that computes various code metrics. that's literally the whole vibe. it looks at your code and goes "here's some numbers about it, bestie" 🔥📊

🎀 Summary 🎀

radon is a Python tool which computes various code metrics. the supported metrics are, and bestie there are four of them so brace yourself:

• raw metrics: SLOC, comment lines, blank lines, etc. 📏
• Cyclomatic Complexity (i.e. McCabe's Complexity) — yes that one, the famous one 👑
• Halstead metrics (all of them. every last one. she's thorough 💅)
• the Maintainability Index (a Visual Studio metric) — fancy fr fr

and the best part?? Radon can be used either from the command line or programmatically through its API. so whether you're a terminal girly or a script girly, she's got you 🌈

🌸 Usage 🌸

radon [-h] [-v] {cc,raw,mi,hal} ...

okay so that's the shape of it. now let's break down every single piece, because nothing gets skipped on my watch 💖

⭐ positional arguments ⭐

• {cc,raw,mi,hal} — pick your fighter, bestie. here's what each one does:
  • cc — Analyze the given Python modules and compute Cyclomatic Complexity (CC). 🌀
  • raw — Analyze the given Python modules and compute raw metrics. 📐
  • mi — Analyze the given Python modules and compute the Maintainability Index. 💎
  • hal — Analyze the given Python modules and compute their Halstead metrics. 🧮

🫶 optional arguments 🫶

• -h, --help — show this help message and exit. the classic. the iconique. she will never let you down 💅
• -v, --version — show program's version number and exit. 💖

🧚 Links 🧚

okay so if you wanna go down the rabbit hole on what Cyclomatic Complexity even is, here's the link the manpage gives you:

<https://dzone.com/articles/
what-exactly-is-mccabe-cyclomatic-complexity>

and here's the tl;dr vibe of it, straight from the page:

Cyclomatic Complexity can be seen simply as the number of independent paths that exist between the input of the function and its output

also two very important little notes, bestie, don't skip these 👀

• radon output consists of columns. The first column indicates F M C - or function method class. 🔤
• Use --exclude "*/filename.py" to skip a particular file(s)

---

👑 Copyright 👑

2012-2017 Michele Lacchia

---

and that's the whole page, you ate it, periodt 🎀✨ this was radon section 1, version 2.3.1, written by Michele Lacchia, copyright 2012-2017 — go compute some metrics bestie, the columns are waiting 💜🦋