python-code-quality 0.1.9__tar.gz → 0.1.10__tar.gz

{python_code_quality-0.1.9 → python_code_quality-0.1.10}/PKG-INFO

@@ -1,20 +1,17 @@
 Metadata-Version: 2.4
 Name: python-code-quality
-Version: 0.1.9
+Version: 0.1.10
 Summary: Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. Minimal tokens.
-Project-URL: Homepage, https://github.com/rhiza-fr/py-cq
-Project-URL: Repository, https://github.com/rhiza-fr/py-cq
+Author: Chris Kilner
 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>=8.4.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
@@ -22,6 +19,9 @@ Requires-Dist: ruff>=0.14.1
 Requires-Dist: ty>=0.0.17
 Requires-Dist: typer>=0.16.0
 Requires-Dist: vulture>=2.14
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/rhiza-fr/py-cq
+Project-URL: Repository, https://github.com/rhiza-fr/py-cq
 Description-Content-Type: text/markdown
 
 # CQ - Python Code Quality Analysis Tool
@@ -115,6 +115,39 @@ cq check . && deploy        # block deploy on errors
 cq check . -o score         # print score, exit 1 on errors
 ```
 
+## 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:
+
+```json
+{
+  "hooks": {
+    "Stop": [{
+      "matcher": "",
+      "hooks": [{"type": "command", "command": "cq check . -o score && echo 'CQ: all clear' || cq check . -o llm"}]
+    }]
+  }
+}
+```
+
+When the score passes, Claude sees `CQ: all clear` (~5 tokens). When it fails, Claude receives the targeted fix prompt and continues working. This automates the `cq check . -o llm | claude -p "fix this"` loop.
+
+> **Note:** Use project-level `.claude/settings.json`, not global settings — this hook only makes sense in Python projects.
+
+### As a slash command (skill)
+
+For manual invocation, create `.claude/commands/cq-fix.md`:
+
+```markdown
+$(cq check . -o llm)
+```
+
+Then invoke it with `/cq-fix` in Claude Code. The `$(...)` embeds the live `cq` output directly into the prompt before Claude starts, so it sees the issue immediately without an extra tool call.
+
+**Hook vs skill:**
+- **Stop hook** — automatic, runs after every session, best for unattended loops
+- **Skill** — manual `/cq-fix`, gives you explicit control over when to check
+
 ## Table output
 
 ```bash

{python_code_quality-0.1.9 → python_code_quality-0.1.10}/README.md

@@ -89,6 +89,39 @@ cq check . && deploy        # block deploy on errors
 cq check . -o score         # print score, exit 1 on errors
 ```
 
+## 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:
+
+```json
+{
+  "hooks": {
+    "Stop": [{
+      "matcher": "",
+      "hooks": [{"type": "command", "command": "cq check . -o score && echo 'CQ: all clear' || cq check . -o llm"}]
+    }]
+  }
+}
+```
+
+When the score passes, Claude sees `CQ: all clear` (~5 tokens). When it fails, Claude receives the targeted fix prompt and continues working. This automates the `cq check . -o llm | claude -p "fix this"` loop.
+
+> **Note:** Use project-level `.claude/settings.json`, not global settings — this hook only makes sense in Python projects.
+
+### As a slash command (skill)
+
+For manual invocation, create `.claude/commands/cq-fix.md`:
+
+```markdown
+$(cq check . -o llm)
+```
+
+Then invoke it with `/cq-fix` in Claude Code. The `$(...)` embeds the live `cq` output directly into the prompt before Claude starts, so it sees the issue immediately without an extra tool call.
+
+**Hook vs skill:**
+- **Stop hook** — automatic, runs after every session, best for unattended loops
+- **Skill** — manual `/cq-fix`, gives you explicit control over when to check
+
 ## Table output
 
 ```bash

{python_code_quality-0.1.9 → python_code_quality-0.1.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-code-quality"
-version = "0.1.9"
+version = "0.1.10"
 description = "Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. Minimal tokens."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -29,11 +29,11 @@ Homepage = "https://github.com/rhiza-fr/py-cq"
 Repository = "https://github.com/rhiza-fr/py-cq"
 
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["uv_build"]
+build-backend = "uv_build"
 
-[tool.hatch.build.targets.wheel]
-packages = ["src/py_cq"]
+[tool.uv.build-backend]
+module-name = "py_cq"
 
 [project.scripts]
 cq = "py_cq.main:main"

python_code_quality-0.1.9/.gitea/workflows/python-multi-version-test.yaml

@@ -1,65 +0,0 @@
-# Template: Multi-version Python testing workflow for Gitea Actions
-# Copy this file to your project's .gitea/workflows/ directory
-#
-# Runs tests against multiple Python versions using generic ubuntu runners.
-# Includes optional dependency upgrade testing.
-
-name: Python Tests
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    name: Python ${{ matrix.python-version }}
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ['3.12', '3.13']
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v7
-
-      - name: Install dependencies
-        run: uv sync --all-extras
-
-      - name: Run tests
-        run: uv run pytest
-
-  # Optional: Test if dependencies can be upgraded
-  upgrade-test:
-    name: Dependency Upgrade Test
-    runs-on: ubuntu-latest
-    continue-on-error: true  # Don't fail the whole workflow if upgrades break
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.14'  # Test upgrades on latest Python
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v7
-
-      - name: Upgrade all dependencies
-        run: uv lock --upgrade
-
-      - name: Install upgraded dependencies
-        run: uv sync --all-extras
-
-      - name: Run tests with upgraded dependencies
-        run: uv run pytest

python_code_quality-0.1.9/.gitea/workflows/test.yaml

@@ -1,11 +0,0 @@
-name: Tests
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: python-test-image
-    steps:
-      - uses: actions/checkout@v4
-      - run: uv sync --all-extras
-      - run: uv run pytest

python_code_quality-0.1.9/.github/workflows/python-publish.yml

@@ -1,70 +0,0 @@
-# This workflow will upload a Python Package to PyPI when a release is created
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Upload Python Package
-
-on:
-  release:
-    types: [published]
-
-permissions:
-  contents: read
-
-jobs:
-  release-build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-
-      - name: Set up Python
-        run: uv python install
-
-      - name: Build release distributions
-        run: |
-          uv build
-    
-      - name: Upload distributions
-        uses: actions/upload-artifact@v4
-        with:
-          name: release-dists
-          path: dist/
-
-  pypi-publish:
-    runs-on: ubuntu-latest
-    needs:
-      - release-build
-    permissions:
-      # IMPORTANT: this permission is mandatory for trusted publishing
-      id-token: write
-
-    # Dedicated environments with protections for publishing are strongly recommended.
-    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
-    environment:
-      name: pypi
-      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
-      # url: https://pypi.org/p/YOURPROJECT
-      #
-      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
-      # ALTERNATIVE: exactly, uncomment the following line instead:
-      url: https://pypi.org/project/python-code-quality/${{ github.event.release.name }}
-
-    steps:
-      - name: Retrieve release distributions
-        uses: actions/download-artifact@v4
-        with:
-          name: release-dists
-          path: dist/
-
-      - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          packages-dir: dist/

python_code_quality-0.1.9/.gitignore

@@ -1,18 +0,0 @@
-# Python-generated files
-__pycache__/
-*.py[oc]
-build/
-dist/
-wheels/
-*.egg-info
-.*_cache/
-# Virtual environments
-.venv
-profile.prof
-analysis_results.json
-.coverage
-.aider*
-.claude
-.cq.json
-
-docs/plans/*

python_code_quality-0.1.9/.python-version

@@ -1 +0,0 @@
-3.14

python_code_quality-0.1.9/CLAUDE.md

@@ -1,54 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Project Overview
-
-CQ is a Python CLI tool for iterative, LLM-assisted code improvement. The primary use case is:
-
-```bash
-cq check -o llm   # returns the single most critical defect as markdown
-```
-
-The LLM fixes it, the user re-runs, and repeats until all tools pass. CQ runs
-11 static analysis tools in execution order (compile → security → lint → types →
-tests → coverage → complexity → dead code → style) and aggregates results into
-a single score.
-
-## Commands
-
-```bash
-# Run tests
-uv run pytest
-
-# Run a single test
-uv run pytest tests/test_common.py::test_score_logistic_variant
-
-# Run the CLI
-uv run cq check              # table output, current directory
-uv run cq check -o llm       # LLM markdown, primary use case
-uv run cq check -o score     # numeric score
-uv run cq check path/to/project/
-
-# Lint
-uv run ruff check src/
-```
-
-## Architecture
-
-**Pipeline flow:** CLI (`cli.py`) → tool registry → execution engine → parsers → metric aggregator → output
-
-- **`cli.py`**: Typer app with a single `check` command. Output mode selected via `--output`/`-o` enum (`table`, `score`, `json`, `llm`). Runs tools in parallel by default. Reads `[tool.cq]` from the target project's `pyproject.toml` and applies overrides before running.
-- **`tool_registry.py`**: Loads `src/cq/config/config.yaml` at import time via `importlib.resources`, dynamically imports parser classes, builds a `dict[str, ToolConfig]` registry.
-- **`config/config.yaml`** (at `src/cq/config/config.yaml`): Declares each analysis tool: shell command template (with `{context_path}` placeholder), parser class name, order, warning/error thresholds. Tools are listed and executed in order.
-- **`execution_engine.py`**: Runs shell commands via `subprocess.run`, caches results with `diskcache` using a content-based hash. Parallel execution via `ThreadPoolExecutor`; results are sorted by order before returning.
-- **`parsers/`**: Each parser subclasses `AbstractParser` (from `localtypes.py`), implementing `parse(RawResult) -> ToolResult` and optionally `format_llm_message(ToolResult) -> str`. Parser module names must match the lowercase parser class name (e.g., `PytestParser` → `pytestparser.py`).
-- **`localtypes.py`**: Core dataclasses — `ToolConfig`, `RawResult`, `ToolResult`, `CombinedToolResults`, and `AbstractParser` ABC.
-- **`metric_aggregator.py`**: Wraps results into `CombinedToolResults`, which computes an overall score as the average of per-tool mean metrics.
-- **`llm_formatter.py`**: Selects the worst-scoring tool by severity tier then order, formats its top defect as markdown for LLM consumption.
-
-## Adding a New Analysis Tool
-
-1. Add tool entry in `config/config.yaml` with command template, parser name, order, and thresholds.
-2. Create `src/cq/parsers/<parsername>.py` with a class matching the `parser` field in YAML.
-3. The parser must subclass `AbstractParser` and implement `parse(RawResult) -> ToolResult`.

python_code_quality-0.1.9/LICENSE

@@ -1,21 +0,0 @@
-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.

python_code_quality-0.1.9/tests/conftest.py

@@ -1,7 +0,0 @@
-"""Shared test helpers."""
-
-from py_cq.localtypes import RawResult
-
-
-def raw(stdout="", return_code=0):
-    return RawResult(tool_name="test", command="cmd", stdout=stdout, return_code=return_code)