regix 0.1.1__tar.gz

regix-0.1.1/LICENSE

@@ -0,0 +1,183 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+Copyright (c) 2026 Tom Sapletta
+
+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.

regix-0.1.1/PKG-INFO

@@ -0,0 +1,382 @@
+Metadata-Version: 2.4
+Name: regix
+Version: 0.1.1
+Summary: Regression Index — detect and measure code quality regressions between git versions
+Author-email: Tom Sapletta <tom@sapletta.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/semcod/regix
+Project-URL: Documentation, https://github.com/semcod/regix/tree/main/docs
+Project-URL: Repository, https://github.com/semcod/regix
+Project-URL: Issues, https://github.com/semcod/regix/issues
+Keywords: regression,refactoring,code-quality,git,cyclomatic-complexity,CI
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13.0
+Provides-Extra: lizard
+Requires-Dist: lizard>=1.17; extra == "lizard"
+Provides-Extra: radon
+Requires-Dist: radon>=6.0; extra == "radon"
+Provides-Extra: coverage
+Requires-Dist: coverage[toml]>=7.0; extra == "coverage"
+Provides-Extra: vallm
+Requires-Dist: vallm>=0.1; extra == "vallm"
+Provides-Extra: docstring
+Provides-Extra: full
+Requires-Dist: lizard>=1.17; extra == "full"
+Requires-Dist: radon>=6.0; extra == "full"
+Requires-Dist: coverage[toml]>=7.0; extra == "full"
+Requires-Dist: vallm>=0.1; extra == "full"
+Provides-Extra: pyqual
+Requires-Dist: pyqual>=0.1.50; extra == "pyqual"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: lizard>=1.17; extra == "dev"
+Requires-Dist: radon>=6.0; extra == "dev"
+Requires-Dist: coverage[toml]>=7.0; extra == "dev"
+Requires-Dist: goal>=2.1.0; extra == "dev"
+Requires-Dist: costs>=0.1.20; extra == "dev"
+Requires-Dist: pfix>=0.1.60; extra == "dev"
+Dynamic: license-file
+
+# Regix — Regression Index for Python Code Quality
+
+
+## AI Cost Tracking
+
+![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-0.1.1-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
+![AI Cost](https://img.shields.io/badge/AI%20Cost-$0.15-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-2.0h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
+
+- 🤖 **LLM usage:** $0.1500 (1 commits)
+- 👤 **Human dev:** ~$200 (2.0h @ $100/h, 30min dedup)
+
+Generated on 2026-03-31 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
+
+---
+
+**Regix** is a Python library for detecting, measuring, and reporting code quality regressions between versions of a codebase. It compares static analysis metrics across git commits, branches, or local snapshots and pinpoints exactly which functions, classes, or lines have regressed — and by how much.
+
+> Inspired by operational experience with [pyqual](https://github.com/semcod/pyqual): iterative quality-gate pipelines revealed that without structured regression tracking, metric changes across refactoring cycles are invisible until a gate breaks.
+
+---
+
+## Problem statement
+
+When refactoring code over multiple iterations:
+
+- A function's cyclomatic complexity improves in one commit, then regresses two commits later.
+- Test coverage drops by 3% after a merge — but no single file is obviously responsible.
+- Maintainability index worsens across three files simultaneously; the cause is spread over dozens of small changes.
+- A CI pipeline fails a quality gate without explaining *what changed* since the last passing run.
+
+Standard linters and quality tools report the **current state**. They do not answer: *"Is this better or worse than before, and where exactly did it change?"*
+
+**Regix answers that question.**
+
+---
+
+## What Regix does
+
+```
+git commit A  ──►  snapshot_A  ─┐
+                                 ├──► compare ──► regression report
+git commit B  ──►  snapshot_B  ─┘
+```
+
+For every function, class, and module it tracks:
+
+| Metric | Unit | Regression when |
+|---|---|---|
+| Cyclomatic complexity (CC) | integer | increases |
+| Maintainability index (MI) | 0–100 | decreases |
+| Test coverage | % | decreases |
+| Function length | lines | increases beyond threshold |
+| Docstring coverage | % | decreases |
+| LLM validation score | 0–1 | decreases (via vallm) |
+| Import count | integer | increases |
+
+Regressions are reported at **three granularity levels**:
+
+1. **Line** — the exact line range that changed and caused the metric shift.
+2. **Symbol** — the function or class whose metric crossed a threshold.
+3. **Module** — the file-level aggregate delta.
+
+---
+
+## Key features
+
+- **Git-native**: compares any two refs (`HEAD~1`, branch names, tags, commit SHAs).
+- **Local-snapshot mode**: compare a dirty working tree against any historical ref without committing.
+- **Multi-version history**: compute a regression timeline across N commits to see trends.
+- **Configurable thresholds**: per-metric, per-file, or per-symbol severity rules.
+- **Multiple backends**: lizard (CC), radon (MI), pytest-cov (coverage), vallm (LLM quality).
+- **Machine-readable output**: JSON, YAML, or TOON format for CI integration.
+- **Human-readable output**: rich terminal tables and diff-style reports.
+- **Zero false-positives mode**: only report regressions that cross a configured threshold delta.
+
+---
+
+## Installation
+
+```bash
+pip install regix
+```
+
+With optional backends:
+
+```bash
+pip install "regix[full]"      # lizard + radon + vallm + pytest-cov
+pip install "regix[lizard]"    # CC + length analysis only
+pip install "regix[coverage]"  # pytest-cov integration only
+```
+
+Python requirement: **>= 3.9**
+
+---
+
+## Quick start
+
+### Compare HEAD against previous commit
+
+```bash
+regix compare HEAD~1 HEAD
+```
+
+```
+Regression Report: HEAD~1 → HEAD
+════════════════════════════════════════════════════════════
+  pyqual/cli.py
+    ▲ bulk_run_cmd        CC  14 → 19  (+5)   ⚠ WARNING
+    ▲ _build_run_summary  CC  12 → 18  (+6)   ✗ ERROR
+
+Summary: 1 error(s), 1 warning(s), 0 improvement(s)
+Gates: ✗ FAIL
+```
+
+### Compare two branches
+
+```bash
+regix compare main feature/refactor --format json > regression.json
+```
+
+### Check before committing
+
+```bash
+regix compare HEAD --local
+```
+
+### Track regressions over last 10 commits
+
+```bash
+regix history --depth 10 --metric cc --metric coverage
+```
+
+### Use from Python
+
+```python
+from regix import Regix, RegressionConfig
+
+cfg = RegressionConfig(cc_max=15, delta_error=5)
+rx = Regix(config=cfg, workdir=".")
+report = rx.compare("HEAD~1", "HEAD")
+
+for regression in report.regressions:
+    print(f"{regression.file}::{regression.symbol}  "
+          f"{regression.metric} {regression.before} → {regression.after}  "
+          f"({regression.severity})")
+
+if report.has_errors:
+    raise SystemExit(1)
+```
+
+---
+
+## Core concepts
+
+### Snapshot
+
+A `Snapshot` is an immutable record of all tracked metrics for a codebase at a specific point in time. It is identified by a git ref (commit SHA, branch, tag) or the special value `"local"` for the current working tree.
+
+```python
+from regix import Snapshot
+
+snap = Snapshot.from_ref("HEAD", workdir=".")
+print(snap.metrics["pyqual/cli.py"]["bulk_run_cmd"]["cc"])  # 19
+```
+
+Snapshots are cached by content hash so repeated comparisons are fast.
+
+### Regression
+
+A `Regression` is a detected worsening of a metric between two snapshots, at symbol, module, or project level.
+
+```python
+@dataclass
+class Regression:
+    file: str            # relative path
+    symbol: str | None   # function or class name, None = module-level
+    line: int | None     # approximate line in the target ref
+    metric: str          # "cc", "mi", "coverage", "length", ...
+    before: float
+    after: float
+    delta: float         # after - before (positive = worse for cc/length)
+    severity: str        # "error" | "warning" | "info"
+    threshold: float     # the configured limit that was crossed
+```
+
+### Improvement
+
+An `Improvement` is the mirror of a `Regression` — a metric that got *better*. Regix tracks both so you get a complete picture of a refactoring.
+
+### Report
+
+A `RegressionReport` aggregates all `Regression` and `Improvement` objects from a comparison, plus summary statistics, gate pass/fail status, and the two snapshot refs.
+
+---
+
+## CLI reference
+
+```
+regix compare [REF_A] [REF_B]    Compare metrics between two git refs
+regix history [--depth N]         Show metric timeline across commits
+regix snapshot [REF]              Capture and store a snapshot
+regix diff [REF_A] [REF_B]       Symbol-level metric diff
+regix gates                       Check against absolute quality gates
+regix status                      Show config and backend availability
+regix init                        Create a default regix.yaml
+```
+
+---
+
+## Configuration
+
+Create `regix.yaml` at the project root, or add `[tool.regix]` to `pyproject.toml`:
+
+```yaml
+regix:
+  metrics:
+    cc_max: 15
+    mi_min: 20
+    coverage_min: 80
+  thresholds:
+    delta_warn: 2
+    delta_error: 5
+  backends:
+    cc: lizard
+    mi: radon
+    coverage: pytest-cov
+  exclude:
+    - "tests/**"
+    - "examples/**"
+  output:
+    format: rich
+    dir: .regix/
+  gates:
+    on_regression: warn
+```
+
+---
+
+## CI Integration
+
+### GitHub Actions
+
+```yaml
+- name: Check for regressions
+  run: |
+    pip install "regix[full]"
+    regix compare ${{ github.event.pull_request.base.sha }} HEAD \
+      --format json --output .regix/report.json
+    regix gates --fail-on error
+```
+
+### Pre-commit hook
+
+```yaml
+repos:
+  - repo: local
+    hooks:
+      - id: regix
+        name: Regression check
+        entry: regix compare HEAD --local --errors-only
+        language: python
+        pass_filenames: false
+```
+
+---
+
+## Design principles
+
+1. **Fix the measurement before fixing the code.** Regix measures only what it can actually analyse.
+2. **Report at symbol granularity.** A file-level average of CC=6.4 masks individual functions with CC=19+.
+3. **Distinguish regression from absolute violation.** CC=18 that was CC=18 last week is an existing issue, not a new regression.
+4. **Stagnation is a signal.** If metrics are identical across iterations, continuing wastes time.
+5. **Make improvements visible too.** Hiding improvements creates a discouraging feedback loop.
+6. **Historical depth is essential.** A single before/after comparison misses the trend.
+7. **Output must be machine-readable.** JSON, YAML, TOON — all stable and versioned.
+
+---
+
+## Architecture
+
+```
+regix/
+├── __init__.py          # Public API: Regix, Snapshot, RegressionReport
+├── cli.py               # Typer CLI (compare, history, diff, gates, ...)
+├── config.py            # RegressionConfig + YAML/TOML loader
+├── models.py            # Snapshot, Regression, Improvement, Report, etc.
+├── snapshot.py          # Snapshot capture, git worktree, file collection
+├── compare.py           # Core comparison engine
+├── history.py           # Multi-commit timeline builder
+├── report.py            # Rendering: rich, JSON, YAML, TOON
+├── gates.py             # Absolute gate evaluation
+├── cache.py             # Content-addressed snapshot cache
+├── git.py               # Git helpers: worktree, ref resolution, diff
+├── exceptions.py        # Typed exceptions
+├── backends/
+│   ├── __init__.py      # BackendBase ABC + registry
+│   ├── lizard_backend.py
+│   ├── radon_backend.py
+│   ├── coverage_backend.py
+│   ├── docstring_backend.py
+│   └── vallm_backend.py
+└── integrations/
+    └── __init__.py      # pyqual preset + gate collector
+```
+
+---
+
+## Ecosystem
+
+Regix is part of the **semcod/wronai** AI-assisted development toolchain:
+
+| Package | Role |
+|---|---|
+| **code2llm** | Static analysis engine |
+| **vallm** | LLM code validator |
+| **regix** | Regression detection layer |
+| **devloop** | Declarative pipeline runner |
+| **planfile** | Universal ticket standard |
+| **llx** | Intelligent LLM router |
+| **proxym** | Dashboard layer |
+| **costs** | AI cost tracker |
+
+---
+
+## License
+
+Licensed under Apache-2.0.