python-code-quality 0.1.4__py3-none-any.whl

python_code_quality-0.1.4.dist-info/METADATA

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: python-code-quality
+Version: 0.1.4
+Summary: Python Code Quality Analysis Tool - feed the results from 11 CQ CQ straight into an LLM.
+Project-URL: Homepage, https://github.com/rhiza-fr/py-cq
+Project-URL: Repository, https://github.com/rhiza-fr/py-cq
+Author-email: Chris Kilner <chris@rhiza.fr>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: bandit>=1.8.0
+Requires-Dist: coverage>=7.8.2
+Requires-Dist: diskcache>=5.6.3
+Requires-Dist: interrogate>=1.7.0
+Requires-Dist: pytest-cov>=6.1.1
+Requires-Dist: pytest-json-report>=1.5.0
+Requires-Dist: pytest>=8.4.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: radon>=6.0.1
+Requires-Dist: rich>=14.0.0
+Requires-Dist: ruff>=0.14.1
+Requires-Dist: ty>=0.0.17
+Requires-Dist: typer>=0.16.0
+Requires-Dist: vulture>=2.14
+Description-Content-Type: text/markdown
+
+# CQ - Python Code Quality Analysis Tool
+
+Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. The primary workflow is:
+
+```bash
+cq check -o llm   # get the single most critical defect as markdown
+```
+
+Feed that output to an LLM, apply the fix, repeat until the score is clean.
+
+## Install
+
+```bash
+uv tool install python-code-quality
+
+# or
+git pull https://github.com/rhiza-fr/py-cq.git
+cd py-cq
+uv tool install .
+```
+
+## Tools
+
+CQ runs these tools in *parallel*:
+
+| Priority | 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 |
+
+## Usage
+
+```bash
+# LLM workflow: get the top defect as markdown (primary use case)
+cq check -o llm
+
+# Rich table with all metrics (default, also saves .cq.json)
+cq check
+
+# Numeric score only — useful in CI or scripts
+cq check -o score
+
+# Full JSON output
+cq check -o json
+
+# Explicit path (defaults to current directory)
+cq check path/to/project/
+cq check path/to/file.py
+
+# Run sequentially (1 worker) instead of in parallel
+cq check --workers 1
+
+# Clear cached results before running
+cq check --clear-cache
+
+# Save table output to a custom file
+cq check --out-file custom_results.json
+
+# Show effective tool configuration (thresholds, enabled/disabled status)
+cq config
+cq config path/to/project/
+```
+
+## Output
+
+```bash
+> cq check .
+```
+
+```python
+┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┓
+┃ 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   │          │
+└──────────────────┴──────────┴───────────────────────────┴─────────┴──────────┘
+```
+```bash
+> cq check . -o score
+```
+```python
+0.9662730667181059 # this is designed to approach but not reach 1.0
+```
+
+```bash
+> cq check . -o llm
+```
+
+```md
+`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.
+```
+
+## Configuration
+
+Add a `[tool.cq]` section to your project's `pyproject.toml`:
+
+```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`.
+
+## LLM workflow
+
+`-o llm` selects the single worst-scoring tool and formats its top defect as
+concise markdown. The LLM fixes it, you re-run `cq check -o llm`, and repeat
+until all tools are green. Priority order ensures the most critical category
+(security, type errors, failing tests) is fixed before cosmetic ones.
+
+## Tools
+
+Many thanks to all the wonderful maintainers of :
+
+- [compileall](https://docs.python.org/3/library/compileall.html)
+- [bandit](https://github.com/PyCQA/bandit)
+- [ruff](https://github.com/astral-sh/ruff)
+- [ty](https://github.com/astral-sh/ty)
+- [pytest](https://github.com/pytest-dev/pytest)
+- [coverage.py](https://github.com/nedbat/coveragepy)
+- [radon](https://github.com/rubik/radon)
+- [vulture](https://github.com/jendrikseipp/vulture)
+- [interrogate](https://github.com/econchick/interrogate)

python_code_quality-0.1.4.dist-info/RECORD

@@ -0,0 +1,31 @@
+py_cq/__init__.py,sha256=rS7kf1RU1zZskvJlkbZaMqEpdRYPspwDPAFbxzF3tXg,373
+py_cq/cli.py,sha256=M0t5noGEt-a1TmTaDvsGKfApcpOZnXjXHiUo_tSdcjk,8586
+py_cq/context_hash.py,sha256=h-i7Rhd7AUfLv9SkQvE79bjJvTsm_ZwoVwSmUKXWmfM,2977
+py_cq/execution_engine.py,sha256=-2W1ySKKiyr_MAEuCbYqtpsmcIFmiAMGd4iB6jpyA6Y,6498
+py_cq/llm_formatter.py,sha256=tOjoWIFEq3ZRGKLcwAnLswQ00B79sM3yJT3K3bh857A,1577
+py_cq/localtypes.py,sha256=Ix871IDcZh8_EldhOrmvR4TPxvWfDi0YhZVSGpI6pl0,5961
+py_cq/main.py,sha256=VKoXI8R8rB2fEROBYoTVURfinLqyh8XTNIIWAOtH7dw,380
+py_cq/metric_aggregator.py,sha256=M2ymo62S7p7qPUqjjoiPg4IVyXQhLMuTr9-jxLiFjCY,853
+py_cq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_cq/storage.py,sha256=J8360OUnGFyQAl_jJ6Eoy5hn7DDpShQvqaU6dFtfrkc,916
+py_cq/tool_registry.py,sha256=9QFqeXxrK7NF-qMd9ZxP5zfqc0nsHVQAbrbAqinAA4g,1535
+py_cq/config/__init__.py,sha256=JZgIe38Lq0XYd-zwOVzi6SxobYBc4lofhidmU4T9_oU,730
+py_cq/config/tools.yaml,sha256=Cjzw58vMOkreZA9EXMzQK5WTfY2YrihnPfNzStvGRQg,2495
+py_cq/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_cq/parsers/banditparser.py,sha256=6Kk3yfNB438Sl2ZfEHeViQ3hlTO0cazNQnJbHJ4RnKc,2131
+py_cq/parsers/common.py,sha256=FWkQIm03IKoCB7pvW4MRbQKjC_quINIKkGq5xKk86qM,3506
+py_cq/parsers/compileparser.py,sha256=GcIcKGVSL8W3zTwfA7WzD045-gNdSeSkljOrPA0qG0M,6496
+py_cq/parsers/complexityparser.py,sha256=2t1-wmNjUu65fULcIm5jcgv7ZLWwjakyiY_r-Fx1QQg,3983
+py_cq/parsers/coverageparser.py,sha256=xDNlLNEsA0U3z4GV02iEq97IL90-UJAQrhMlFzpIdy0,4013
+py_cq/parsers/halsteadparser.py,sha256=Rj690m_C4KRdlfrTC_bXtT5_-oJPKT38I7V-v1CDoJY,8980
+py_cq/parsers/interrogateparser.py,sha256=eMROINtyZE2eHrRxVU0jA-nYTdvr0PZ8iERVn7kPH5o,2197
+py_cq/parsers/maintainabilityparser.py,sha256=Ax0ZFA6zzqYIWZH1hP1_GUtdVn2LIJ8SKWtqVNdszYs,3411
+py_cq/parsers/pytestparser.py,sha256=FrAaNJfDHZmEr_vRYQpp04qRj4Cq3jaDhpnAFxLv5dQ,4047
+py_cq/parsers/ruffparser.py,sha256=WMJhsYA5wwBcIhqGSfjBxy78RGv_iCJJ1Qdmt1dqTOw,2567
+py_cq/parsers/typarser.py,sha256=bC6-P-NGBMJBLyr1DkX1yMtnTS8afuRO0Keb_XyBeg0,2787
+py_cq/parsers/vultureparser.py,sha256=fe-LPagivKGtmf6Kyu_gT0OrWJjowAsJ2OhXQiv_zQY,1888
+python_code_quality-0.1.4.dist-info/METADATA,sha256=IdFzOrXj1Cn-EdAoNJ-zoxEYqWBI3_pEJ1bRYCKa_co,6745
+python_code_quality-0.1.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+python_code_quality-0.1.4.dist-info/entry_points.txt,sha256=j5Q_gGr0b7389lddt1JlZ7gcL4Z7RHxuDhij_G-IhBY,39
+python_code_quality-0.1.4.dist-info/licenses/LICENSE,sha256=Bpuh8tbf37so8M5NtRGTLmT5ue7diJ17223L9f9nsT0,1086
+python_code_quality-0.1.4.dist-info/RECORD,,

python_code_quality-0.1.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

python_code_quality-0.1.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cq = py_cq.main:main

python_code_quality-0.1.4.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chris Kilner <chris@rhiza.fr>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.