Identifying the highest threats to your code quality by analyzing code metrics of your project using pytest and pylint.
Project description
CodeRadar
Identifying the highest threats to your code quality by analyzing code metrics of your project using pytest and pylint.
Status: Beta (runs, but certainly has bugs)
Authors: Carsten König
Purpose
In order to quickly see where an existing project needs refactoring, an overview of the worst code smells is needed. This package therefore summarizes these in a very brief report, that should guide you directly to the places in your software where an improvement would have the highest impact when you want to improve code quality.
Installation
pip install coderadar
How to use
In order to analyze your sourcecode, go to your project root folder and run
coderadar <path-to-source>
This will run pytest, pylint and flake8 to get the metrics that will be analyzed.
The following artifacts will be created:
coverage.xml
coverage.txt
pylint.json
pylint.txt
code_quality_report.html
code_quality_report.txt
If you run coderadar
under Python 2.7, the following artifacts will be created additionally, in order to assess Python 3 compatibility:
pylint_py3.json
pylint_py3.txt
If you place these artifacts in a folder called last_run
, located in the directory where you run the command, the results of the last run are automatically compared to the current run.
License
Author
Carsten König
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for coderadar-0.5.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 365ccf11ee2bc513b2e53adc5deede1b782a9ed80d0f7c68f094dd0769b403cf |
|
MD5 | 4aa2f1df1a41f654156d186f40250a11 |
|
BLAKE2b-256 | c678c1623e4ab05f95bd6f6cfa842bb450b8fbf12d1015c826d628c2144b95bd |