python-code-quality 0.1.16__py3-none-any.whl → 0.2.1__py3-none-any.whl

{python_code_quality-0.1.16.dist-info → python_code_quality-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-code-quality
-Version: 0.1.16
+Version: 0.2.1
 Summary: Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. Minimal tokens.
 Author: Chris Kilner
 Author-email: Chris Kilner <chris@rhiza.fr>
@@ -15,10 +15,10 @@ Requires-Dist: interrogate>=1.7.0
 Requires-Dist: pytest>=8.4.0
 Requires-Dist: pytest-cov>=6.1.1
 Requires-Dist: pytest-json-report>=1.5.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: tomlkit>=0.13.0
 Requires-Dist: ty>=0.0.17
 Requires-Dist: typer>=0.16.0
 Requires-Dist: vulture>=2.14
@@ -88,6 +88,7 @@ Diskcache is used to cache tool output for lightning fast re-runs. Sane defaults
 ```bash
 cq check .                 # Table overview of scores for humans
 cq check . -o llm          # Top defect as markdown for LLMs
+cq check . -o llm-json     # Top defect as JSON with fingerprint (for automation)
 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
@@ -97,7 +98,9 @@ cq check . --skip bandit   # Skip specific tools
 cq check . --exclude demo  # Exclude paths from all tools
 cq check . --workers 1     # Run sequentially if you like things slow
 cq check . --clear-cache   # Clear cached results before running (rarely needed)
+cq check . -o llm --hint   # Append "run cq again to verify" (for human workflows)
 cq config path/to/project/ # Show effective tool configuration
+cq is-fixed <fingerprint>  # Check whether a specific issue has been resolved
 ```
 
 **Exit codes:** `cq check` exits with code `1` if any tool metric falls below its `error_threshold`, making it suitable as a CI gate:
@@ -107,6 +110,88 @@ cq check . && deploy        # block deploy on errors
 cq check . -o score         # print score, exit 1 on errors
 ```
 
+## Fingerprint-based verification
+
+`-o llm-json` returns a JSON object with a stable `id` fingerprint you can pass back to `cq is-fixed` to check whether a specific issue has been resolved — without re-running all tools:
+
+```bash
+# Get the top defect as JSON
+cq check . -o llm-json
+```
+
+```json
+{
+  "id": "ruff::my-project::src/foo.py::42::E501",
+  "file": "src/foo.py",
+  "project": "/home/user/my-project",
+  "message": "..."
+}
+```
+
+```bash
+# After fixing, verify only that issue (fast — reruns one tool on one file)
+cq is-fixed "ruff::my-project::src/foo.py::42::E501"
+```
+
+This is most useful in automation: fix an issue, confirm it's gone, then fetch the next one. Note that this only verifies the original issue is no longer present — a full project-wide scan is still needed to guarantee no regressions, assuming you have sufficient tests.
+
+## Python Library
+
+`py_cq` can be used as a library — no subprocess required. Instantiate `CQ` with a project root; config is loaded once from `pyproject.toml`.
+
+```python
+from py_cq import CQ
+
+cq = CQ(".")                      # load config from ./pyproject.toml
+cq = CQ(".", skip=["bandit"])     # skip specific tools
+cq = CQ(".", only=["ruff", "ty"]) # run only specific tools
+cq = CQ(".", workers=4)           # control parallelism
+```
+
+**Methods mirror the CLI and return data objects:**
+
+```python
+# list[ToolResult] — all parsed results before aggregation (-o raw / -o json)
+results = cq.raw()
+
+# CombinedToolResults — aggregated score and per-tool results (-o score / table)
+combined = cq.check()
+print(combined.score)          # float
+print(combined.tool_results)   # list[ToolResult]
+
+# dict — top defect as JSON, equivalent to -o llm-json
+issue = cq.check_llm_json()
+issue["id"]       # fingerprint: "ruff::project::src/foo.py::42::E501"
+issue["file"]     # "src/foo.py"
+issue["message"]  # markdown prompt ready to send to an LLM
+issue["project"]  # absolute project root path
+
+# bool — True if the fingerprinted issue is gone
+# Reruns only the affected tool on the affected file — much faster than a full check.
+# Pass the id from check_llm_json; also available as `cq is-fixed <id>` on the CLI.
+fixed = cq.is_fixed(issue["id"])
+```
+
+`check_llm_json` accepts the same options as `cq check . -o llm-json`:
+
+```python
+issue = cq.check_llm_json(limit=3, silence=["src/generated.py"], hint=True)
+```
+
+**Typical automation loop:**
+
+```python
+from py_cq import CQ
+
+cq = CQ(".")
+while True:
+    issue = cq.check_llm_json()
+    if issue["id"] is None:
+        break                        # all clear
+    fix(issue["message"])            # call your LLM
+    assert cq.is_fixed(issue["id"])
+```
+
 ## Claude Code Integration
 
 Add a stop hook to your project's `.claude/settings.json` so Claude automatically checks quality after each session and loops until clean:
@@ -346,7 +431,7 @@ python:
     error_threshold: 0.8
 
   interrogate:
-    command: "{python} -m interrogate \"{context_path}\" -e tests{exclude} -v --fail-under 0"
+    command: "{python} -m interrogate \"{context_path}\"{exclude} -v --fail-under 0"
     exclude_format: " -e {path}"
     parser: "InterrogateParser"
     order: 11

python_code_quality-0.2.1.dist-info/RECORD

@@ -0,0 +1,35 @@
+py_cq/__init__.py,sha256=-C6_QzQeydxft3ndlExTgWnvlqH8fJNPJxfySXULQmU,56
+py_cq/api.py,sha256=iyiL5WDdQDYSwkqmZ_AuFY8-uJ-mM9WWAQhpdjqVk20,9170
+py_cq/cli.py,sha256=5Vw3BPyqjKPeWQBXYCMs_ps7WJmjdhxQFgaNS9lAxiQ,13391
+py_cq/config/__init__.py,sha256=f0wc51O_3kGDTZUnCbGv8_zWnC5yYGl4NWcf2buSImQ,670
+py_cq/config/config.toml,sha256=L8WKLQg4utDvV1ZwcOCSi6uJAtE1mZPvY-_HJVOT2dk,2841
+py_cq/context_hash.py,sha256=UKVrKpBYYw68tVcSAs6ZXkHXV3asQvsn6R9NINOHQ4M,3323
+py_cq/execution_engine.py,sha256=GdrLk8Gok5Kf1FSr39LqMfj1GOoLyJeSfU9qWT_7n4Y,14147
+py_cq/language_detector.py,sha256=rh5bAA3LyCQR3RODmx_EalqRNYvSYK2SJzh2hIkxOUo,1139
+py_cq/llm_formatter.py,sha256=nCV3nFdxJAi2CnH9FKb5tB-0w-yjLWmjywQI5GJ2cSU,8412
+py_cq/localtypes.py,sha256=ELzOFOFlrLSq5Wgj5LvBIPhWR8wfe7lQYkcbINhqE3A,7559
+py_cq/main.py,sha256=5dgr8Zk1LNK5M-0wncYVksBp0qE-jWZYqmOXfb1eOhk,400
+py_cq/metric_aggregator.py,sha256=M2ymo62S7p7qPUqjjoiPg4IVyXQhLMuTr9-jxLiFjCY,853
+py_cq/parsers/__init__.py,sha256=uCy7R0cnvDPNvB5aWMLgM3FB9nDcu1jwUmznFMRROSY,28
+py_cq/parsers/banditparser.py,sha256=YqpWljU5D4IhLdtzat7XVGBm9NXrbOQbr9LI9NKybK8,3298
+py_cq/parsers/common.py,sha256=dU5JCbPJdngbtPjSqnP0kxT2Oux5D-iYiaBMz8KcZCw,13672
+py_cq/parsers/compileparser.py,sha256=jl0DloyXTKqVHRIUft-t5lvJOndY-PdLPrXB38v9zuA,6927
+py_cq/parsers/complexityparser.py,sha256=dOUCpCDcpNaQXZx_xC61X4dTMktDb9x_nh9tDoWjb5g,5509
+py_cq/parsers/coverageparser.py,sha256=t15CFfTJv1QorhopyurDvY7Jr5JJOMLfet0fqttU3O0,7848
+py_cq/parsers/exitcodeparser.py,sha256=b4LWIwwklPwCX3MnqNsGQC1slQU56DKE05vJ0OdWVoA,957
+py_cq/parsers/halsteadparser.py,sha256=cfUNsLUYt74NMQW1sBkktn8AH7jQ_EU5IMFrLgIdk5M,10165
+py_cq/parsers/interrogateparser.py,sha256=cc5Q4mOQlLUIPl3XUyH29QJ_JMBzAA7SiPAAiNGDJdM,11546
+py_cq/parsers/linecountparser.py,sha256=-hqebwG4j7_QugzGLUUQRcPukGHicV2nbIp1pR8ZcAw,1310
+py_cq/parsers/maintainabilityparser.py,sha256=3a4m93XNtUurw3IxEI1Iae9idgJY6qiEt7HMYl1wTu0,4793
+py_cq/parsers/pytestparser.py,sha256=rhzFzsBEXv1xloOuEjQyBn8Vp0AyGoq2t5siyAwWWaA,11549
+py_cq/parsers/regexcountparser.py,sha256=zGzHEYDIori6aiWnVkRFixdE7fWt66npAAWjzvpoBF4,1592
+py_cq/parsers/ruffparser.py,sha256=ofQyVUuc0JK-6pVdwsRZteCWmNBOIfHzZloVPSH7_wI,7608
+py_cq/parsers/typarser.py,sha256=x835OrapG1aUteW2NhC5U0bhj1w1pMtbfmbvb74-1AI,8077
+py_cq/parsers/vultureparser.py,sha256=-yGAXzRY4_fzLRTk7dfwDrrRZ-n97j1Ph5_xo3c6TfU,2229
+py_cq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_cq/table_formatter.py,sha256=2_WZ2RHCwsdna0bzP6ZFxB2YtHtW95wxJB1yBXgCIDo,1610
+py_cq/tool_registry.py,sha256=kWmGsqc_0ryYiW-hqUh03WdY1SJQ0wn5Z5ydH72VJK4,1718
+python_code_quality-0.2.1.dist-info/WHEEL,sha256=Q9FtwzuR2QE37l-JIkuyklGnJJiCBHKnsPVQ9vzCMzQ,81
+python_code_quality-0.2.1.dist-info/entry_points.txt,sha256=cfWbTw7eYO6Trv1-Z_odL6Zta9CqYU6Vk9lAHdfB60Q,40
+python_code_quality-0.2.1.dist-info/METADATA,sha256=fXzBeBOrxJ9jO-fglDIUiZiqCnxjnN1f4OBcsBX4gn8,15650
+python_code_quality-0.2.1.dist-info/RECORD,,

{python_code_quality-0.1.16.dist-info → python_code_quality-0.2.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.11.7
+Generator: uv 0.11.17
 Root-Is-Purelib: true
 Tag: py3-none-any

py_cq/config/config.yaml

@@ -1,94 +0,0 @@
-python:
-
-  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
-
-  ruff:
-    command: "{python} -m ruff check --output-format concise --no-cache \"{context_path}\"{exclude}"
-    exclude_format: " --exclude {path}"
-    parser: "RuffParser"
-    order: 2
-    warning_threshold: 0.9999
-    error_threshold: 0.9
-
-  ty:
-    command: "{python} -m ty check --output-format concise --color never \"{context_path}\"{exclude}"
-    exclude_format: " --exclude {path}"
-    parser: "TyParser"
-    order: 3
-    warning_threshold: 0.9999
-    error_threshold: 0.8
-    run_in_target_env: true
-    extra_deps:
-      - ty
-
-  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{exclude}\""
-    exclude_format: ",{input_path_posix}/{path}"
-    parser: "BanditParser"
-    order: 4
-    warning_threshold: 0.9999
-    error_threshold: 0.8
-
-  pytest:
-    command: "{python} -m pytest -v \"{context_path}\"{exclude}"
-    exclude_format: " --ignore {path}"
-    parser: "PytestParser"
-    order: 5
-    warning_threshold: 1.0
-    error_threshold: 1.0
-    run_in_target_env: true
-    extra_deps:
-      - pytest
-
-  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
-
-  radon-cc:
-    command: "{python} -m radon cc --json \"{context_path}\""
-    parser: "ComplexityParser"
-    order: 7
-    warning_threshold: 0.6
-    error_threshold: 0.4
-
-  radon-mi:
-    command: "{python} -m radon mi -s --json \"{context_path}\""
-    parser: "MaintainabilityParser"
-    order: 8
-    warning_threshold: 0.6
-    error_threshold: 0.4
-
-  radon-hal:
-    command: "{python} -m radon hal -f --json \"{context_path}\""
-    parser: "HalsteadParser"
-    order: 9
-    warning_threshold: 0.5
-    error_threshold: 0.3
-
-  vulture:
-    command: "{python} -m vulture \"{context_path}\" --min-confidence 80 --exclude .venv,dist,.*_cache,docs,.git{exclude}"
-    exclude_format: ",{path}"
-    parser: "VultureParser"
-    order: 10
-    warning_threshold: 0.9999
-    error_threshold: 0.8
-
-  interrogate:
-    command: "{python} -m interrogate \"{context_path}\" -e tests{exclude} -v --fail-under 0"
-    exclude_format: " -e {path}"
-    parser: "InterrogateParser"
-    order: 11
-    warning_threshold: 0.8
-    error_threshold: 0.3

python_code_quality-0.1.16.dist-info/RECORD

@@ -1,34 +0,0 @@
-py_cq/__init__.py,sha256=U2ysDtSFdv2mlXZz4w1Q42pfgfi6YY_3Ln24bkZq14I,260
-py_cq/cli.py,sha256=bbol813ZJMSmGixNUrNfmWqPv4evil0chwyIChEgc20,11265
-py_cq/config/__init__.py,sha256=f0wc51O_3kGDTZUnCbGv8_zWnC5yYGl4NWcf2buSImQ,670
-py_cq/config/config.yaml,sha256=TPZJogpWbyf0Ml2mHrHzTNyTik3k07KPVGsA1wT9GEc,2696
-py_cq/context_hash.py,sha256=h-i7Rhd7AUfLv9SkQvE79bjJvTsm_ZwoVwSmUKXWmfM,2977
-py_cq/execution_engine.py,sha256=nAsCvldUfDagZnfOwXf4A37VQLxCGiv12T8ymutflC4,8697
-py_cq/language_detector.py,sha256=6av5HaimcZ54RkN69xQmGgC0mxtTvGzPV3SL8NGG8Uc,1116
-py_cq/llm_formatter.py,sha256=l74O5iqNWMR16789Xncoi93xOqgQJhW5IQK9_OyA9mE,1632
-py_cq/localtypes.py,sha256=UGI2kl1xB2TedKGByth3URiqJKY56YZMNds1hnLEzvU,6228
-py_cq/main.py,sha256=5dgr8Zk1LNK5M-0wncYVksBp0qE-jWZYqmOXfb1eOhk,400
-py_cq/metric_aggregator.py,sha256=M2ymo62S7p7qPUqjjoiPg4IVyXQhLMuTr9-jxLiFjCY,853
-py_cq/parsers/__init__.py,sha256=YS3wPS0cMNU80zkdSZBEZOkqDKE6Jk--0Xd_bX7VMcA,27
-py_cq/parsers/banditparser.py,sha256=BbwDFyvG9uA-S7-u4QETCXbLRx62juxZUl5IHSQgoCs,2667
-py_cq/parsers/common.py,sha256=X4T8pbToJH-xFYmTvKq1k7bEAmA71XxBXbp8rXYUMBU,8654
-py_cq/parsers/compileparser.py,sha256=_SQzfADuZEDLn9M67PR8cScMyNQH9UJijGQIS54WtQs,6883
-py_cq/parsers/complexityparser.py,sha256=SHle0oF179aDTHV6ENDWg16w50g0of9QMG-Yah6QAcU,4220
-py_cq/parsers/coverageparser.py,sha256=cfkcEBWprjtdn16tBDEix9p30xL3eYcARvpLzpmJgIk,4066
-py_cq/parsers/exitcodeparser.py,sha256=ZFL3EbPhGvFjm2qZhfLD1_5dNjR9ULYNQpKgy0Z_dGo,729
-py_cq/parsers/halsteadparser.py,sha256=cRVi2su7v7DtRF339V4tmc8QY604wOYkg4qZ0RICCgM,9411
-py_cq/parsers/interrogateparser.py,sha256=7ROwvJKz-OBLd2ACsi2RINfYr3yjav-I3_SmYlStVTA,2309
-py_cq/parsers/linecountparser.py,sha256=nxWvFntuR8T6FDGpafrlevvt-jR3rwkbVo_t2JX4TF0,1067
-py_cq/parsers/maintainabilityparser.py,sha256=65w36toQ-gMhBliyvmMVVVNolrcB3xD4ebu5eJ7T1yQ,3658
-py_cq/parsers/pytestparser.py,sha256=_seSfvAD_88A-yDyWYpLuIrLL2Wjp3rbcqG3fNCNEnA,9705
-py_cq/parsers/regexcountparser.py,sha256=KSoNh2spucXU06pxxr2QW0LrPLfJkFMAsmSgjooaFv0,1316
-py_cq/parsers/ruffparser.py,sha256=C6NPA1ZIXtvLGb5WOApyixT6bGwfIT6th6Bhc65UVhE,2500
-py_cq/parsers/typarser.py,sha256=rjlM-fiKV5EoYCHV-6cHhvG2rJ7vz6F_aSzvbuQ7UJY,3361
-py_cq/parsers/vultureparser.py,sha256=A9AeB3GczXbWNgHIkI7MPlobxccR5FJMV1delQppxXY,2226
-py_cq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-py_cq/table_formatter.py,sha256=LpyVcl03OAjcifP-9qDy_BJQGyqTe0PJjYRrRCjo9Rc,1293
-py_cq/tool_registry.py,sha256=UfmwJH8rtmTY9kX02QaE4OJIWyboTMcXUavgb9R4fxc,1648
-python_code_quality-0.1.16.dist-info/WHEEL,sha256=WvwXFgRajeoYkfRVmDhkP4Qlqo31Mk687zIO2QQoFmw,80
-python_code_quality-0.1.16.dist-info/entry_points.txt,sha256=cfWbTw7eYO6Trv1-Z_odL6Zta9CqYU6Vk9lAHdfB60Q,40
-python_code_quality-0.1.16.dist-info/METADATA,sha256=FlRLE3X9lki316FiuZlD1twudLoSDPRMv9Uv0nHPWH8,12749
-python_code_quality-0.1.16.dist-info/RECORD,,