This package aims to provide hints on the quality of a python code. It extracts metrics from various code quality reporting tools. This package does not replace these tools but point out which ones should be run for a better understanding of the code content.
To use the code metrics as a package use the setup script with
python setup.py install
Go to the parent folder of your source code and run
python -m metrics <sources_path>
Ideally, there should be a tests folder containing your unit tests.
Additional help is available with
python -m metrics -h
The icon on the top of this document are generated in the sub-folder
doc/metrics by running
python -m metrics --svg doc/metrics metrics
The metrics computed by this package are provided by
Deeper explanation of the metrics can be obtained by reading their corresponding documentation. In a nutshell, here is a succinct description of the metrics:
| Name | Type | Description | Further references |
|---|---|---|---|
| Code style | float | One minus the number of PEP8 error violations divided by the number of lines. | |
| Cyclomatic complexity - average | float | Average cyclomatic complexity | |
| Cyclomatic complexity - maximum | integer | Maximum cyclomatic complexity | |
| Code path | string | Path of the evaluated code | |
| Report date | date | Metrics report production date | |
| Documentation rate | [0,1] | Documentation rate wrt. total number of lines | |
| Lines of code | positive integer | Number of logical lines of code | |
| Maintainability index | [0,1] | Maintainability index computed by Radon | [*] |
| Max cyclomatic complexity function | string | Reference to the function with the maximum cyclomatic complexity | |
| Tests coverage | [0,1] | Coverage rate of the unit tests |