Skip to main content

Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. Minimal tokens.

Project description

CQ - Python Code Quality Analysis Tool

Feed the results from 11+ code quality tools to an LLM. Minimal tokens.

The primary workflow is:

# get the single most critical defect as markdown
cq check . -o llm

Selects the single most critical defect using this priority order:

  1. Severity — tools with score below error_threshold come before those only below warning_threshold
  2. Order — among tools at the same severity, lower-order tools win (compile before lint before style)
  3. Score — among ties, the lower score wins

The code context is expanded if available.

`data/problems/travelling_salesman/ts_bad.py:21`**F841**: Local variable `unused_variable` is assigned to but never used

18:     min_dist = float("inf")
19:     nearest_city = None
20:     for city in cities:
21:         unused_variable = 67
22:         dist = calc_dist(current_city, city)
23:         if dist < min_dist:
24:             min_dist = dist
25:             nearest_city = city

Please fix only this issue. After fixing, run `cq check . -o llm` to verify.

Feed to an LLM with edit tools and repeat until there are no issues, e.g.

cq check . -o llm | claude -p "fix this"
# or
cq check . -o llm | ollama gpt-oss:20b "Explain how to fix this"

Install

# install the `cq` command line tool from PyPi
uv tool install python-code-quality

# or, clone it then install 
git pull https://github.com/rhiza-fr/py-cq.git
cd py-cq
uv tool install .

Tools

These tools are run in parallel except when looking for the first error in -o llm mode:

Order Tool Measures
1 compileall Syntax errors
2 bandit Security vulnerabilities
3 ruff Lint / style
4 ty Type errors
5 pytest Test pass rate
6 coverage Test coverage
7 radon cc Cyclomatic complexity
8 radon mi Maintainability index
9 radon hal Halstead volume / bug estimate
10 vulture Dead code
11 interrogate Docstring coverage

Diskcache is used to cache tool output for lightning fast re-runs. Sane defaults: <100 Mb, <5 days, No pickle

Usage

cq check .                 # Table overview of scores for humans
cq check -o llm            # Top defect as markdown for LLMs
cq check . -o score        # Numeric score only for CI
cq check . -o json         # Detailed parsed JSON output for jq
cq check . -o raw          # Raw tool output for debug
cq check path/to/file.py   # Just one file (skips pytest and coverage)
cq check . --workers 1     # Run sequentially if you like things slow
cq check . --clear-cache   # Clear cached results before running (rarely needed)
cq config path/to/project/ # Show effective tool configuration

Table output

> cq check .
┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┓
 Tool                  Time                     Metric  Score    Status   
┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━┩
 compile              0.42s                    compile  1.000    OK       
 bandit               0.56s                   security  1.000    OK       
 ruff                 0.17s                       lint  1.000    OK       
 ty                   0.33s                 type_check  1.000    OK       
 pytest               0.91s                      tests  1.000    OK       
 coverage             1.26s                   coverage  0.910    OK       
 radon cc             0.32s                 simplicity  0.982    OK       
 radon mi             0.38s            maintainability  0.869    OK       
 radon hal            0.30s              file_bug_free  0.928    OK       
 radon hal                              file_smallness  0.851    OK       
 radon hal                          functions_bug_free  0.913    OK       
 radon hal                         functions_smallness  0.724    OK       
 vulture              0.32s                  dead_code  1.000    OK       
 interrogate          0.36s               doc_coverage  1.000    OK       
                                                 Score  0.965             
└──────────────────┴──────────┴───────────────────────────┴─────────┴──────────┘

Single score output

> cq check . -o score
0.9662730667181059 # this is designed to approach but not reach 1.0

Json output

> cq check . -o json
[
  {
    "tool_name": "compile",
    "metrics": {
      "compile": 1.0
    },
    "details": {},
    "duration_s": 0.05611889995634556
  }
  ...
]

Raw output

> cq check -o raw
[
  {
    "tool_name": "compile",
    "command": "D:\\ai\\py-cq\\.venv\\Scripts\\python.exe -m compileall -r 10 -j 8 . -x .*venv",
    "stdout": "",
    "stderr": "",
    "return_code": 0,
    "timestamp": "2026-02-20 10:01:22"
  }
  ...
]

Configuration

Add a [tool.cq] section to your project's pyproject.toml:

[tool.cq]
# Skip tools that are slow or not relevant to your project
disable = ["coverage", "interrogate"]

# Override warning/error thresholds per tool
[tool.cq.thresholds.coverage]
warning = 0.9
error = 0.7

Tool IDs match the keys in config/tools.yaml: compilation, bandit, ruff, ty, pytest, coverage, complexity, maintainability, halstead, vulture, interrogate.

Default config

tools:

  compilation:
    name: "compile"
    command: "{python} -m compileall -r 10 -j 8 {context_path} -x .*venv"
    parser: "CompileParser"
    order: 1
    warning_threshold: 0.9999
    error_threshold: 0.9999

  bandit:
    name: "bandit"
    command: "{python} -m bandit -r {context_path} -f json -q -s B101 --severity-level medium --exclude {input_path_posix}/.venv,{input_path_posix}/tests"
    parser: "BanditParser"
    order: 2
    warning_threshold: 0.9999
    error_threshold: 0.8

  ruff:
    name: "ruff"
    command: "{python} -m ruff check --output-format concise --no-cache {context_path}"
    parser: "RuffParser"
    order: 3
    warning_threshold: 0.9999
    error_threshold: 0.9

  ty:
    name: "ty"
    command: "{python} -m ty check --output-format concise --color never {context_path}"
    parser: "TyParser"
    order: 4
    warning_threshold: 0.9999
    error_threshold: 0.8
    run_in_target_env: true
    extra_deps:
      - ty

  pytest:
    name: "pytest"
    command: "{python} -m pytest -v {context_path}"
    parser: "PytestParser"
    order: 5
    warning_threshold: 0.7
    error_threshold: 0.5
    run_in_target_env: true

  coverage:
    name: "coverage"
    command: "{python} -m coverage run --omit=*/tests/*,*/test_*.py -m pytest {context_path} && {python} -m coverage report --omit=*/tests/*,*/test_*.py"
    parser: "CoverageParser"
    order: 6
    warning_threshold: 0.9
    error_threshold: 0.5
    run_in_target_env: true
    extra_deps:
      - coverage
      - pytest

  complexity:
    name: "radon cc"
    command: "{python} -m radon cc --json {context_path}"
    parser: "ComplexityParser"
    order: 7
    warning_threshold: 0.6
    error_threshold: 0.4

  maintainability:
    name: "radon mi"
    command: "{python} -m radon mi -s --json {context_path}"
    parser: "MaintainabilityParser"
    order: 8
    warning_threshold: 0.6
    error_threshold: 0.4

  halstead:
    name: "radon hal"
    command: "{python} -m radon hal -f --json {context_path}"
    parser: "HalsteadParser"
    order: 9
    warning_threshold: 0.5
    error_threshold: 0.3

  vulture:
    name: "vulture"
    command: "{python} -m vulture {context_path} --min-confidence 80 --exclude .venv,dist,.*_cache,docs,.git"
    parser: "VultureParser"
    order: 10
    warning_threshold: 0.9999
    error_threshold: 0.8

  interrogate:
    name: "interrogate"
    command: "{python} -m interrogate {context_path} -v --fail-under 0"
    parser: "InterrogateParser"
    order: 11
    warning_threshold: 0.8
    error_threshold: 0.3

Respect

Many thanks to all the wonderful maintainers of :

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_code_quality-0.1.8.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_code_quality-0.1.8-py3-none-any.whl (39.1 kB view details)

Uploaded Python 3

File details

Details for the file python_code_quality-0.1.8.tar.gz.

File metadata

  • Download URL: python_code_quality-0.1.8.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for python_code_quality-0.1.8.tar.gz
Algorithm Hash digest
SHA256 a7b099edfee7e707ad72f5e28506505a12e15a88e7d262e05a7e8833c8412bd4
MD5 8220c1ce25b89015ae1d1d43b15e83bb
BLAKE2b-256 f0332c9be68ffd315c14f9209d2f498439a1358129788600ae41fe42103b6fbc

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_code_quality-0.1.8.tar.gz:

Publisher: python-publish.yml on rhiza-fr/py-cq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file python_code_quality-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for python_code_quality-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6c172a236bba54d7ffa9a89905f5c2edd4075edf8f7ee38fa92be2ef22daab74
MD5 85ff9b9e20094c48273a182f52ba66a7
BLAKE2b-256 7c1ccc55455d6f98130ca88dd3735448b5ba3bb469f954e52a7e50bbd446c7f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_code_quality-0.1.8-py3-none-any.whl:

Publisher: python-publish.yml on rhiza-fr/py-cq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page