.\" Man page generated from reStructuredText.
.
.TH  "1" "" "2.3.1" ""
.SH NAME
radon \- Python tool to compute code metrics
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
\fBradon\fP is a Python tool which computes various code metrics.
.SS Summary
.sp
Radon is a Python tool which computes various code metrics. Supported metrics are:
.INDENT 0.0
.IP \(bu 2
raw metrics: SLOC, comment lines, blank lines, etc.
.IP \(bu 2
Cyclomatic Complexity (i.e. McCabe\(aqs Complexity)
.IP \(bu 2
Halstead metrics (all of them)
.IP \(bu 2
the Maintainability Index (a Visual Studio metric)
.UNINDENT
.sp
Radon can be used either from the command line or programmatically through its API.
.SS Usage
.sp
radon [\-h] [\-v] {cc,raw,mi,hal} ...
.SS positional arguments
.INDENT 0.0
.INDENT 3.5
{cc,raw,mi,hal}
.INDENT 0.0
.INDENT 3.5
cc             Analyze the given Python modules and compute Cyclomatic Complexity (CC).
.sp
raw            Analyze the given Python modules and compute raw metrics.
.sp
mi             Analyze the given Python modules and compute the Maintainability Index.
.sp
hal            Analyze the given Python modules and compute their Halstead metrics.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS optional arguments
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.B \-v\fP,\fB  \-\-version
show program\(aqs version number and exit
.UNINDENT
.UNINDENT
.UNINDENT
.SS Links
.sp
\fI\%https://dzone.com/articles/what\-exactly\-is\-mccabe\-cyclomatic\-complexity\fP
.sp
Cyclomatic Complexity can be seen simply as the number of independent paths that exist between the input of the function and its output
.sp
\fBradon\fP output consists of columns. The first column indicates \fBF M C\fP \- or \fBfunction\fP \fBmethod\fP \fBclass\fP\&.
.sp
Use \-\-exclude \fB"*/filename.py"\fP to skip a particular file(s)
.SH COPYRIGHT
2012-2017 Michele Lacchia
.\" Generated by docutils manpage writer.
.