Welcome to Radon’s documentation!

---

Radon is a Python tool which computes various code metrics. Supported metrics are:

• raw metrics: SLOC, comment lines, blank lines, &c.
• Cyclomatic Complexity (i.e. McCabe’s Complexity)
• Halstead metrics (all of them)
• the Maintainability Index (a Visual Studio metric)

Radon can be used either from the command line or programmatically through its API.

Contents:

• Introduction to Code Metrics
  • Cyclomatic Complexity
  • Maintainability Index
  • Raw Metrics
  • Halstead Metrics
  • Further Reading
• Command-line Usage
  • Radon configuration files
  • Usage with Jupyter Notebooks
  • The cc command
  • The mi command
  • The raw command
  • The hal command
• Flake8 plugin
• Using radon programmatically
  • Cyclomatic Complexity
  • Raw metrics
  • Other metrics
  • Visitors
  • Harvesters
• Changelog
  • 6.0.1 (Mar 26, 2023)
  • 6.0.0 (Mar 26, 2023)
  • 5.1.0 (Aug 08, 2021)
  • 5.0.1 (Jun 08, 2021)
  • 4.5.2 (May 23, 2021)
  • 4.5.1 (May 09, 2021)
  • 4.5.0 (Mar 09, 2021)
  • 4.4.0 (Mar 07, 2021)
  • 4.3.2 (Sep 18, 2020)
  • 4.3.1 (Sep 12, 2020)
  • 4.2.0 (Jan 28, 2020)
  • 4.1.0 (Jan 28, 2020)
  • 4.0.0 (Sep 19, 2019)
  • 3.0.1 (Feb 03, 2019)
  • 3.0.0 (Jan 26, 2019)
  • 2.4.0 (Oct 11, 2018)
  • 2.3.1 (Oct 02, 2018)
  • 2.3.0 (Oct 02, 2018)
  • 2.2.0 (Jan 11, 2018)
  • 2.1.1 (Sep 07, 2017)
  • 2.0.3 (Aug 30, 2017)
  • 2.0.2 (Jun 04, 2017)
  • 2.0.1 (Jun 02, 2017)
  • 2.0.0 (May 30, 2017)
  • 1.5.0 (Mar 14, 2017)
  • 1.4.2 (Jul 26, 2016)
  • 1.4.0 (Jun 03, 2016)
  • 1.3.0 (Mar 02, 2016)
  • 1.2.2 (Jul 09, 2015)
  • 1.2.1 (May 07, 2015)
  • 1.2 (Jan 16, 2015)
  • 1.1 (Sep 6, 2014)
  • 1.0 (Aug 15, 2014)
  • 0.5.3 (Aug 1, 2014)
  • 0.5.2 (Jul 24, 2014)
  • 0.5.1 (Mar 4, 2014)
  • 0.5 (Feb 17, 2014)
  • 0.4.5 (Dec 16, 2013)
  • 0.4.4 (Nov 20, 2013)
  • 0.4.2 (Jun 25, 2013)
  • 0.4.1 (Jun 16, 2013)
  • 0.4 (Apr 26, 2013)
  • 0.3 (Nov 2, 2012)
  • 0.2 (Oct 11, 2012)
  • 0.1 (Never)

Indices and tables

• Index
• Module Index
• Search Page