pyntegritydb 0.3.0

Una biblioteca para medir la calidad de la integridad referencial en bases de datos relacionales.

pyntegritydb

pyntegritydb es una herramienta de línea de comandos para analizar y medir la calidad de la integridad referencial en bases de datos relacionales. Basada en el paper académico "Referential Integrity Quality Metrics", la biblioteca te ayuda a diagnosticar rápidamente relaciones rotas o "huérfanas" en tu esquema.

---

Características Principales

• Análisis Dual: Mide tanto la Completitud (filas huérfanas) como la Consistencia (datos desnormalizados incorrectos).
• Sistema de Alertas: Define umbrales de calidad en un archivo config.yml y recibe alertas si tus datos no cumplen con los estándares.
• Soporte Multi-DB: Compatible con cualquier base de datos que soporte SQLAlchemy (PostgreSQL, MySQL, SQLite, etc.).
• Reportes Flexibles: Genera reportes en múltiples formatos: tabla para la consola (cli), json o csv.
• Visualización de Esquema: Crea un mapa visual de la salud de tus relaciones con el flag --visualize.

---

Instalación

Instala pyntegritydb directamente desde PyPI:

pip install pyntegritydb

---

Guía de Inicio Rápido

Ejecuta un análisis completo, genera un reporte en JSON y un mapa visual con un solo comando.

1. Crea tu Archivo de Configuración

Crea un archivo config.yml (ver Guía de Uso Completa para más detalles).

En tu proyecto, crea un archivo config.yml:

# config.yml
thresholds:
  default:
    validity_rate: 0.99 # Al menos 99% de las FKs deben ser válidas
    
  tables:
    orders:
      validity_rate: 1.0 # La tabla 'orders' debe ser perfecta

consistency_checks:
  orders: 
    - on_fk: ["user_id"]
      attributes:
        customer_name: name

2. Ejecuta el Análisis

Usa el comando pyntegritydb apuntando a tu base de datos y a tu archivo de configuración.

pyntegritydb "postgresql://user:pass@host/db" \
      --config config.yml \
      --format json \
      --output-file report.json \
      --visualize \
      --output-image schema_health.png

Esto generará dos archivos: report.json con los resultados detallados y schema_health.png con el mapa visual de tu base de datos.

3. Interpreta el Reporte

pyntegritydb generará un reporte completo en tu consola, mostrando primero las alertas, y luego los análisis detallados.

🚦 Reporte de Alertas 🚦
=========================
- ALERTA [Completitud]: La tabla 'orders' viola el umbral de 'validity_rate'. Esperado >= 100.00%, Obtenido = 98.50%

### Reporte de Completitud (Filas Huérfanas) ###
+-----------------+------------------+-----------------+-----------------+-------------+
| Tabla de Origen | Tabla de Destino | Tasa de Validez | Filas Huérfanas | Total Filas |
+=================+==================+=================+=================+=============+
| orders          | users            | 98.50%          | 15              | 1000        |
+-----------------+------------------+-----------------+-----------------+-------------+
...

---

Documentación

Para una guía detallada, tutoriales y la referencia completa de la API, visita nuestra documentación oficial en pyntegritydb.readthedocs.io.

---

Desarrollo

Si quieres contribuir al proyecto, sigue estos pasos:

1. Clona el repositorio:

   git clone [https://github.com/tu_usuario/pyntegritydb.git](https://github.com/tu_usuario/pyntegritydb.git)
   cd pyntegritydb
   

2. Crea y activa un entorno virtual:

   python3 -m venv venv
   source venv/bin/activate
   

3. Instala las dependencias en modo editable:

   pip install -e ".[dev]" 
   # (Necesitarás definir los 'dev' extras en pyproject.toml para pytest, etc.)
   

4. Ejecuta las pruebas:

   pytest
   

---

Licencia

Este proyecto está bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.