Skip to main content

Declarative quality gate loops for AI-assisted development

Project description

pyqual

AI Cost Tracking

PyPI Version Python License AI Cost Human Time Model

  • ๐Ÿค– LLM usage: $1.0500 (7 commits)
  • ๐Ÿ‘ค Human dev: ~$500 (5.0h @ $100/h, 30min dedup)

Generated on 2026-03-29 using openrouter/qwen/qwen3-coder-next


Declarative quality gate loops for AI-assisted development.

One YAML file. One command. Pipeline iterates until your code meets quality thresholds.

pip install pyqual
pyqual init
pyqual run

The problem

You use Copilot, Claude, GPT. They generate code. But nobody checks if that code meets your quality standards before it hits code review. And nobody automatically iterates if it doesn't.

pyqual closes that gap: define metrics โ†’ run tools โ†’ check gates โ†’ if fail, LLM fixes โ†’ re-check โ†’ repeat until pass.

How it works

pyqual.yaml defines everything:
    โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
    โ”‚  metrics:                               โ”‚
    โ”‚    cc_max: 15        โ† quality gates    โ”‚
    โ”‚    vallm_pass_min: 90                   โ”‚
    โ”‚    coverage_min: 80                     โ”‚
    โ”‚                                         โ”‚
    โ”‚  stages:                                โ”‚
    โ”‚    - analyze  (code2llm)                โ”‚
    โ”‚    - validate (vallm)                   โ”‚
    โ”‚    - fix      (llx/aider, when: fail)   โ”‚
    โ”‚    - test     (pytest)                  โ”‚
    โ”‚                                         โ”‚
    โ”‚  loop:                                  โ”‚
    โ”‚    max_iterations: 3                    โ”‚
    โ”‚    on_fail: report                      โ”‚
    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

pyqual run:
    Iteration 1 โ†’ analyze โ†’ validate โ†’ fix โ†’ test โ†’ check gates
                                                         โ”‚
                                              โ”Œโ”€โ”€ PASS โ”€โ”€โ”ดโ”€โ”€ FAIL โ”€โ”€โ”
                                              โ”‚                     โ”‚
                                           Done โœ…          Iteration 2...

pyqual.yaml

pyqual can be configured via pyqual.yaml or [tool.pyqual] in pyproject.toml:

Option 1: pyqual.yaml (recommended)

pipeline:
  name: quality-loop

  metrics:
    cc_max: 15           # cyclomatic complexity per function
    vallm_pass_min: 90   # vallm validation pass rate (%)
    coverage_min: 80     # test coverage (%)

  stages:
    - name: analyze
      run: code2llm ./ -f toon,evolution

    - name: validate
      run: vallm batch ./ --recursive --errors-json > .pyqual/errors.json

    - name: fix
      run: echo "Connect your LLM fixer here"
      when: metrics_fail    # only runs if gates fail

    - name: test
      run: pytest --cov --cov-report=json:.pyqual/coverage.json

  loop:
    max_iterations: 3
    on_fail: report         # report | create_ticket | block

Option 2: pyproject.toml

If pyqual.yaml doesn't exist, pyqual will automatically check pyproject.toml:

[tool.pyqual]
name = "quality-loop"

[tool.pyqual.metrics]
cc_max = 15
vallm_pass_min = 90
coverage_min = 80

[[tool.pyqual.stages]]
name = "analyze"
run = "code2llm ./ -f toon,evolution"

[[tool.pyqual.stages]]
name = "test"
run = "pytest --cov --cov-report=json:.pyqual/coverage.json"
when = "always"

[tool.pyqual.loop]
max_iterations = 3
on_fail = "report"

CLI

pyqual init              # create pyqual.yaml
pyqual run               # execute full loop
pyqual run --dry-run     # preview without executing
pyqual gates             # check gates without running stages
pyqual status            # show current metrics
pyqual doctor            # check tool availability
pyqual plugin list       # list available plugins

Python API

from pyqual import Pipeline, PyqualConfig

config = PyqualConfig.load("pyqual.yaml")
pipeline = Pipeline(config, workdir="./my-project")
result = pipeline.run()

if result.final_passed:
    print(f"All gates passed in {result.iteration_count} iterations")
else:
    print("Gates not met โ€” check result.iterations for details")

LLM Integration

pyqual includes built-in LLM support via liteLLM. Configure via .env:

OPENROUTER_API_KEY=sk-or-v1-...
LLM_MODEL=openrouter/qwen/qwen3-coder-next

Use in your code:

from pyqual import get_llm

llm = get_llm()  # Auto-loads config from .env

# Simple completion
response = llm.complete("Explain Python decorators")
print(response.content)

# Fix code issues
response = llm.fix_code(
    code="def foo(x): return x + 1",  # missing type hints
    error="Function lacks type annotations"
)
print(response.content)

# Access cost info
print(f"Cost: ${response.cost:.4f}")

See examples/llm_fix/ for complete examples.

Metric sources

pyqual automatically collects metrics from:

Source Metrics How
analysis_toon.yaml cc (CCฬ„), critical Regex parse from code2llm output
validation_toon.yaml vallm_pass Pass rate from vallm batch
.pyqual/errors.json error_count Count of vallm errors
.pyqual/coverage.json coverage pytest-cov JSON report

Security & Dependencies:

Source Metrics File Command
pip-audit vuln_critical, vuln_high, vuln_medium, vuln_low, vuln_total .pyqual/pip_audit.json pip-audit --format=json
bandit bandit_high, bandit_medium, bandit_low .pyqual/bandit.json bandit -r . -f json
trufflehog/gitleaks secrets_found, secrets_severity .pyqual/trufflehog.json trufflehog filesystem . --json
pip outdated_deps .pyqual/outdated.json pip list --outdated --format=json

Code Quality:

Source Metrics File Command
mypy mypy_errors .pyqual/mypy.json mypy . --show-error-codes
ruff ruff_errors, ruff_fatal, ruff_warnings .pyqual/ruff.json ruff check . --output-format=json
pylint pylint_errors, pylint_score, pylint_fatal, pylint_warning .pyqual/pylint.json pylint . --output-format=json
flake8 flake8_violations, flake8_errors, flake8_warnings, flake8_conventions .pyqual/flake8.json flake8 . --format=json
radon mi_avg, mi_min, cc_rank_avg .pyqual/radon_mi.json radon mi . -j
interrogate docstring_coverage, docstring_total, docstring_missing .pyqual/interrogate.json interrogate . -v --json
pytest test_time, slow_tests .pyqual/pytest_durations.json pytest with durations

Advanced Metrics:

Category Available Metrics
Performance bench_time, bench_regression, mem_usage, cpu_time
SBOM/Licensing sbom_compliance, sbom_coverage, vuln_supply_chain, license_blacklist
Code Health unused_count, pyroma_score
Git/Repo git_branch_age, todo_count, bus_factor, commit_frequency, contributor_diversity
LLM Quality llm_pass_rate, code_bleu, ai_generated_pct, hallucination_rate, faithfulness_score
AI Cost ai_cost
i18n i18n_coverage, i18n_missing, i18n_total
Accessibility a11y_issues, a11y_critical, a11y_score

Custom metrics: extend GateSet._collect_metrics() or add your own collector.

Gate operators

metrics:
  cc_max: 15           # cc โ‰ค 15
  coverage_min: 80     # coverage โ‰ฅ 80
  critical_max: 0      # critical โ‰ค 0
  error_count_max: 5   # error_count โ‰ค 5
  vallm_pass_min: 90   # vallm_pass โ‰ฅ 90

Suffixes: _max โ†’ โ‰ค, _min โ†’ โ‰ฅ, _lt โ†’ <, _gt โ†’ >, _eq โ†’ =

Integration with ecosystem

pyqual is intentionally small (~800 lines). It orchestrates, not implements:

  • code2llm does analysis โ†’ pyqual reads the .toon output
  • vallm does validation โ†’ pyqual reads pass rates
  • llx does LLM routing โ†’ pyqual calls it as a stage
  • planfile manages tickets โ†’ pyqual creates tickets on gate failure
  • costs tracks spending โ†’ pyqual can gate on budget
  • algitex can import pyqual as a dependency for its go command

Examples

See examples/ directory for real-world configurations:

Project setups:

Specialized configurations:

  • security/ โ€” Security-first scanning (bandit, pip-audit, secrets)
  • linters/ โ€” Comprehensive linting (ruff, pylint, flake8, mypy)

CI/CD:

Python API usage:

  • basic โ€” Using Pipeline and GateSet from Python
  • llm_fix โ€” LLM integration for auto-fixing code
  • custom_gates โ€” Custom quality gates and metrics

Why not add this to algitex?

algitex has 29,448 lines, CCฬ„=3.6, 64 critical issues, vallm pass 42.8%. Adding more features makes it worse. pyqual does one thing well: declarative quality gate loops. algitex imports pyqual. Both improve.

License

Licensed under Apache-2.0.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyqual-0.1.11.tar.gz (140.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyqual-0.1.11-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file pyqual-0.1.11.tar.gz.

File metadata

  • Download URL: pyqual-0.1.11.tar.gz
  • Upload date:
  • Size: 140.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for pyqual-0.1.11.tar.gz
Algorithm Hash digest
SHA256 1c2d5607140510403733d1dc969c1f3e33c19fb0b7050563cdc89af468feb577
MD5 c9137c9ddc237b24ff646c64db52e8b8
BLAKE2b-256 29634b7bb6a9061ed56779b75679b09471e422a4016aad8f220ae148ad090d1c

See more details on using hashes here.

File details

Details for the file pyqual-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: pyqual-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for pyqual-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 05f3b0e17c6ce200e22df28f0a6a3c6dba6cde366a2450e302839cdd46f11be1
MD5 13fbf4f98bfb08232b82965e2df3eb70
BLAKE2b-256 0362fcd27bc21117f017eeec1214d334d930612dbefccbb6f545002ecb7cc7f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page