Skip to main content

Biblioteca Python para análise de qualidade e saúde de código

Project description

CodeHealthAnalyzer

Biblioteca Python para análise de saúde de código com foco em três frentes:

  • violações de tamanho em módulos, classes, funções e templates
  • CSS/JS inline em templates HTML
  • erros de linting coletados via Ruff

O que a biblioteca entrega hoje

  • API Python com CodeAnalyzer, ViolationsAnalyzer, TemplatesAnalyzer e ErrorsAnalyzer
  • CLI com os comandos analyze, violations, templates, errors, score, info, dashboard, format e lint
  • relatórios em json, html, markdown e csv
  • dashboard FastAPI opcional com métricas agregadas
  • contrato de relatório tipado e versão centralizada

Instalação

pip install codehealthanalyzer

Com dashboard:

pip install "codehealthanalyzer[web]"

Para desenvolvimento:

pip install -e ".[dev,web]"

Uso rápido

CLI

codehealthanalyzer analyze .
codehealthanalyzer analyze . --format all --output reports
codehealthanalyzer violations . --format csv
codehealthanalyzer templates . --config config.json
codehealthanalyzer errors . --no-json --format markdown
codehealthanalyzer dashboard .

API Python

from codehealthanalyzer import CodeAnalyzer

analyzer = CodeAnalyzer(".", config={"target_dir": ".", "templates_dir": ["templates"]})
report = analyzer.generate_full_report(output_dir="reports")
print(report["summary"]["quality_score"])

Configuração

Exemplo de config.json:

{
  "limits": {
    "python_function": { "yellow": 30, "red": 50 },
    "python_class": { "yellow": 300, "red": 500 },
    "python_module": { "yellow": 500, "red": 1000 },
    "html_template": { "yellow": 150, "red": 200 },
    "test_file": { "yellow": 400, "red": 600 }
  },
  "target_dir": ".",
  "templates_dir": ["templates", "app/templates"],
  "exclude_dirs": ["legacy", "vendor"],
  "ruff_fix": false,
  "no_default_excludes": false
}

Campos suportados:

  • limits: sobrescreve limites de tamanho
  • target_dir: diretório analisado pelo Ruff
  • templates_dir: string ou lista de diretórios de templates
  • exclude_dirs: string ou lista de diretórios extras a ignorar
  • ruff_fix: roda ruff check --fix antes da coleta
  • no_default_excludes: desabilita as exclusões padrão

Contrato de relatório

O relatório consolidado sempre contém:

{
    "metadata": {...},
    "summary": {...},
    "violations": {...},
    "templates": {...},
    "errors": {...},
    "priorities": [...],
    "quality_score": 0,
}

Os schemas tipados ficam em codehealthanalyzer/schemas.py.

Desenvolvimento

pytest -q
ruff check codehealthanalyzer tests
black --check codehealthanalyzer tests
isort --check-only codehealthanalyzer tests

Limitações atuais

  • a análise de erros depende do executável ruff estar disponível no ambiente
  • o dashboard mostra métricas agregadas, não histórico persistente completo
  • a análise de templates é baseada em heurísticas simples de HTML e regex

Project details


Download files

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

Source Distribution

codehealthanalyzer-1.2.1.tar.gz (61.5 kB view details)

Uploaded Source

Built Distribution

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

codehealthanalyzer-1.2.1-py3-none-any.whl (51.9 kB view details)

Uploaded Python 3

File details

Details for the file codehealthanalyzer-1.2.1.tar.gz.

File metadata

  • Download URL: codehealthanalyzer-1.2.1.tar.gz
  • Upload date:
  • Size: 61.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for codehealthanalyzer-1.2.1.tar.gz
Algorithm Hash digest
SHA256 6cbea33f255f4e3614238a56127bf69ea7199ec906932853591db4e6cdc8e5fe
MD5 4a4ed713cf75a15bc1ec834e326027b4
BLAKE2b-256 ac230be1392806afc1aa74adaed4b87a5e62c5135166f3645262fe5e3045791a

See more details on using hashes here.

File details

Details for the file codehealthanalyzer-1.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for codehealthanalyzer-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 00fc0a6e6b758816be8f56ce1a5b5d4360e31a22181e7e96abbbaf4d1304a9d4
MD5 404f3c2b66acb46c7b7eecf0ff3c2c02
BLAKE2b-256 1180a0f91e677439ca59d033c5014f7133f6b2dd2a01e04b0b616b3728c96862

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