🌐 Mejorador Automático de Páginas Web para Todos

¿Qué hace este programa? En palabras sencillas, es una herramienta que hace que las páginas web sean más fáciles de usar para todas las personas, especialmente para aquellas con alguna discapacidad, y lo hace de forma automática usando Inteligencia Artificial.

📋 ¿Qué encontrarás en este documento?

• 💡 ¿Para qué sirve?
• ✨ ¿Qué puede hacer?
• 🔧 ¿Qué necesitas para usarlo?
• ⚙️ ¿Cómo instalarlo?
• 🚀 ¿Cómo usarlo?
• 📊 ¿Cómo funciona por dentro?
• 📁 ¿Dónde se guardan los resultados?
• 🛠️ ¿Qué tecnología usa?
• 🏗️ Arquitectura del Sistema

🏗️ Arquitectura del Sistema

El sistema está diseñado con una arquitectura modular que permite procesar y mejorar páginas web de manera eficiente. Aquí está el diagrama de la arquitectura:

accessibility-project/
├── main.py                     # Punto de entrada de la aplicación
├── requirements.txt            # Dependencias del proyecto
├── README.md                   # Documentación principal
│
├── core/                       # Núcleo de la aplicación
│   ├── analyzer.py            # Análisis de accesibilidad
│   ├── html_generator.py      # Generación de HTML accesible
│   ├── image_processing.py    # Procesamiento de imágenes
│   ├── report.py             # Generación de informes
│   └── webdriver_setup.py     # Configuración de Selenium
│
├── utils/                      # Utilidades y helpers
│   ├── violation_utils.py     # Manejo de violaciones WCAG
│   ├── io_utils.py           # Operaciones de entrada/salida
│   └── html_utils.py         # Utilidades para HTML
│
├── config/                     # Configuraciones
│   └── constants.py          # Constantes globales
│
└── templates/                  # Plantillas
    └── comparison_template.html # Template para informes

Componentes Principales:

1. 🔍 Analizador de Accesibilidad

   • Punto de entrada del sistema
   • Coordina el proceso de análisis
   • Gestiona las solicitudes web mediante Selenium

2. 📊 Detector de Problemas

   • Utiliza axe-core para identificar problemas de accesibilidad
   • Genera un informe detallado de issues
   • Prioriza los problemas según su gravedad

3. 🖼️ Procesador de Imágenes

   • Gestiona la extracción y análisis de imágenes
   • Se conecta con OpenAI para generar descripciones
   • Mantiene un caché local de descripciones previas

4. 🛠️ Motor de Correcciones

   • Aplica las mejoras necesarias al código HTML
   • Implementa las correcciones de accesibilidad
   • Gestiona la integración de las descripciones de imágenes

5. 📝 Generador de Informes

   • Crea informes detallados del proceso
   • Genera comparativas antes/después
   • Produce métricas de mejora

6. 🗄️ Base de Datos Local

   • Almacena descripciones de imágenes
   • Cachea resultados para optimizar el rendimiento
   • Mantiene un historial de análisis

💡 ¿Para qué sirve?

Imagina que tienes una página web y quieres asegurarte de que cualquier persona pueda usarla, independientemente de si:

• Usa un lector de pantalla porque tiene dificultades visuales
• No puede usar el ratón y navega solo con teclado
• Tiene dificultades para distinguir ciertos colores
• O cualquier otra situación que pueda dificultar el uso de la web

Este programa analiza automáticamente tu página web y:

1. Encuentra problemas que podrían hacer difícil su uso
2. Los corrige automáticamente cuando es posible
3. Te muestra un informe detallado de las mejoras realizadas

✨ ¿Qué puede hacer?

• 🔍 Encuentra Problemas Automáticamente:

  • Revisa toda la página web buscando elementos que podrían ser difíciles de usar
  • Comprueba que cumple con las normas internacionales de accesibilidad (WCAG 2.0)

• 🤖 Usa Inteligencia Artificial:

  • Describe las imágenes para personas que no pueden verlas
  • Sugiere mejoras en los textos para que sean más claros
  • Corrige problemas en el código de la página

• 💾 Es Eficiente:

  • Guarda las descripciones de imágenes para no tener que generarlas de nuevo
  • Trabaja rápido y de forma inteligente

• 📊 Te Mantiene Informado:

  • Crea informes fáciles de entender
  • Muestra el "antes y después" de las mejoras
  • Te explica qué ha cambiado y por qué

🔧 ¿Qué necesitas para usarlo?

1. En tu ordenador debe estar instalado:

   • Python (versión 3.8 o más nueva)
   • Google Chrome
   • Conexión a Internet

2. Necesitarás también:

   • Una clave de API de OpenAI (es como una contraseña especial para usar la Inteligencia Artificial)
   • Un poco de espacio en tu disco duro para guardar los resultados

⚙️ ¿Cómo instalarlo?

1. Primer paso: Obtener el programa

   git clone https://github.com/CarlaFernandez12/accessibility.git
   cd <NOMBRE-DEL-DIRECTORIO>

   (Tu supervisor te proporcionará los valores correctos para reemplazar lo que está entre < >)

2. Segundo paso: Preparar el entorno

   # Si usas Windows, escribe esto en la terminal:
   python -m venv venv
   venv\Scripts\activate
   
   # Si usas Mac o Linux, escribe esto en su lugar:
   python -m venv venv
   source venv/bin/activate

3. Tercer paso: Instalar lo necesario

   pip install -r requirements.txt

4. Cuarto paso: Configurar la clave de API

   • Crea un archivo nuevo llamado .env en la carpeta principal
   • Dentro del archivo escribe:

     OPENAI_API_KEY="tu-clave-api-aquí"
     

   • Guarda el archivo

🚀 ¿Cómo usarlo?

1. Iniciar el programa

   python main.py --url "https://ejemplo.com/"

2. Usar el programa

   • Cuando te lo pida, escribe la dirección web que quieres analizar
   • Espera mientras el programa:
     • Analiza la página
     • Encuentra problemas
     • Aplica mejoras
     • Genera el informe

3. Ver los resultados

   • El programa te dirá dónde encontrar los resultados
   • Podrás ver:
     • Qué problemas encontró
     • Qué mejoras hizo
     • Cómo quedó la página después de las mejoras

📊 ¿Cómo funciona por dentro?

El programa sigue estos pasos:

1. 🔍 Análisis

   • Visita la página web que le indicas
   • Busca problemas de accesibilidad
   • Hace una lista de todo lo que necesita mejorar

2. 📸 Mejora de imágenes

   • Descarga las imágenes de la página
   • Usa IA para describirlas
   • Guarda las descripciones para usarlas después

3. 🔧 Mejoras en la página

   • Añade las descripciones a las imágenes
   • Corrige problemas en la estructura
   • Mejora textos poco claros

4. 📈 Creación del informe

   • Compara cómo era la página antes y después
   • Cuenta cuántas mejoras se hicieron
   • Crea un informe fácil de entender

📁 ¿Dónde se guardan los resultados?

El programa crea una carpeta llamada results con esta estructura:

results/
└── nombre_de_la_web/
    └── fecha_y_hora/
        ├── initial_report.json    (problemas encontrados)
        ├── accessible_page.html   (página mejorada)
        ├── final_report.json      (mejoras realizadas)
        └── comparison_report.html (informe comparativo)

🛠️ ¿Qué tecnología usa?

• 🐍 Python: El lenguaje de programación principal
• 🤖 OpenAI: La Inteligencia Artificial que ayuda a mejorar la página
• 🌐 Selenium: Herramienta para navegar automáticamente por la web
• 🎯 axe-core: Detector de problemas de accesibilidad
• 🔍 BeautifulSoup4: Herramienta para leer y modificar páginas web
• 📝 Jinja2: Creador de informes bonitos y claros

📝 Descripción de Componentes

📁 Directorio Raíz

• main.py: Archivo principal que inicia el proceso de análisis y mejora de accesibilidad
• requirements.txt: Lista de dependencias Python necesarias
• README.md: Este archivo de documentación

📁 Directorio core/

El corazón de la aplicación, contiene los módulos principales:

core/
├── analyzer.py         # Analiza páginas web en busca de problemas de accesibilidad
├── html_generator.py   # Genera versiones accesibles de páginas HTML
├── image_processing.py # Procesa imágenes y genera descripciones alternativas
├── report.py          # Crea informes detallados de accesibilidad
└── webdriver_setup.py  # Configura y gestiona el navegador automatizado

📁 Directorio utils/

Herramientas y utilidades de apoyo:

utils/
├── violation_utils.py  # Funciones para procesar violaciones de accesibilidad
├── io_utils.py        # Funciones de lectura/escritura de archivos
└── html_utils.py      # Funciones auxiliares para manipulación de HTML

📁 Directorio config/

Configuraciones del sistema:

config/
└── constants.py       # Define constantes, rutas y configuraciones globales

📁 Directorio templates/

Plantillas para la generación de informes:

templates/
└── comparison_template.html  # Template para mostrar cambios antes/después

🔄 Flujo de Trabajo

1. main.py coordina todo el proceso
2. Los módulos en core/ realizan el trabajo principal:
   • analyzer.py → Análisis inicial
   • image_processing.py → Mejora de imágenes
   • html_generator.py → Generación de HTML accesible
   • report.py → Creación de informes
3. Los módulos en utils/ proporcionan funciones de apoyo
4. config/constants.py mantiene la configuración centralizada
5. Las plantillas en templates/ se usan para generar los informes finales

---

📄 Licencia: MIT
👩‍💻 Autora: Carla

🤝 ¿Necesitas ayuda?

Si tienes alguna duda o problema:

1. Revisa que has seguido todos los pasos correctamente
2. Asegúrate de que tu ordenador cumple con los requisitos
3. Contacta con el equipo de soporte si necesitas más ayuda

📝 Notas importantes

• El programa necesita conexión a Internet para funcionar
• Algunas mejoras pueden tardar unos minutos en completarse
• Es normal que el navegador se abra y cierre solo mientras el programa trabaja
• Los informes se guardan automáticamente para que puedas consultarlos cuando quieras