regix

Regix Documentation

Regix — Regression Index for Python code quality.

Detects, measures and reports code quality regressions between git versions at function, class and line granularity.


Documents

Document Description
README.md Overview, quick start, CLI reference, design principles
api.md Full Python API: Regix, Snapshot, RegressionReport, backends, git helpers
architecture.md Module layout, data flow, design decisions, extension points
configuration.md regix.yaml / pyproject.toml full reference, threshold tuning, common configs
pyproject.toml Library scaffold ready to copy as a new repo root

Origin

This documentation was designed based on operational experience with the pyqual iterative quality-gate pipeline. The key lessons that shaped Regix: