Auto-actualizacion de README

Implementa un script para actualizar el README.md automáticamente cada vez que se hace una modificación en la carpeta docs durante un push.

Author: Jalkhov

.github/workflows/readmemd.yaml

@@ -0,0 +1,33 @@
+name: Actualizar README
+
+on:
+  push:
+    paths:
+      - 'docs/**' # Se activa cuando se modifica algo en la carpeta "docs"
+
+jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout código
+        uses: actions/checkout@v2
+
+      - name: Configurar Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+
+      - name: Instalar dependencias
+        run: pip install -r potools/requirements.txt
+
+      - name: Ejecutar script
+        run: python readme_update.py
+
+      - name: Confirmar el README.md
+        uses: EndBug/add-and-commit@v9
+        with:
+          committer_name: GitHub Actions
+          committer_email: [email protected]
+          add: .
+          message: 'Actualiza información de los archivos .po'

potools/po_analizer.py

@@ -0,0 +1,64 @@
+"""Analiza los achivos .po y obtiene información necesaria para actualizar el README.md"""
+
+import os
+import polib
+from tabulate import tabulate
+
+def contar_strings_faltantes(pofile):
+    """
+    Cuenta los archivos .po que faltan por traducir
+    """
+    po = polib.pofile(pofile)
+    strings_faltantes = 0
+
+    for entry in po:
+        if not entry.translated() and not entry.obsolete:
+            strings_faltantes += 1
+
+    return strings_faltantes
+
+def obtener_last_translator(pofile):
+    """
+    Obtiene al ultimo traductor del archivo .po dado
+    """
+    po = polib.pofile(pofile)
+    last_translator = po.metadata.get("Last-Translator", "Desconocido")
+    return last_translator
+
+def po_analize():
+    """
+    Itera los archivos .po y obtiene la resectiva información
+    """
+    # Directorio donde se encuentran los archivos .po y sus subdirectorios
+    directorio_base = "docs/locales/es/LC_MESSAGES"
+    data = []
+    total_faltantes = 0
+
+    for root, _, archivos in os.walk(directorio_base):
+        for archivo in archivos:
+            if archivo.endswith(".po"):
+                ruta_completa = os.path.join(root, archivo)
+                # Obtener el directorio padre
+                # directorio_padre = os.path.dirname(ruta_completa)
+                # Eliminar el string contenido en directorio_base
+                ruta_final = ruta_completa.replace(directorio_base, "")
+                # Verificar si hay strings faltantes
+                faltantes = contar_strings_faltantes(ruta_completa)
+                # Obtener el Last-Translator
+                last_translator = obtener_last_translator(ruta_completa)
+                # Mostrar la ruta final, OK/NO y Last-Translator
+                if faltantes == 0:
+                    data.append([ruta_final, "SÍ", last_translator])
+                else:
+                    data.append([ruta_final, f"NO ({faltantes} restantes)", last_translator])
+                total_faltantes += faltantes
+
+    # Ordenar las filas por la ruta del archivo (primera columna)
+    data.sort(key=lambda x: x[0])
+
+    headers = ["Archivo", "Traducción completa", "Último traductor"]
+
+    return tabulate(data, headers=headers, tablefmt="github")
+
+if __name__ == "__main__":
+    print(po_analize())

potools/po_cleanner.py

@@ -0,0 +1,41 @@
+"""Ese archivo elimina los strings obsoletos de todos los archivos .po"""
+
+import os
+import polib
+
+
+def eliminar_strings_obsoletos(pofile):
+    """
+    Elimina los strings obsoletos del archivo .po dado
+    """
+    po = polib.pofile(pofile)
+    strings_a_eliminar = []
+
+    for entry in po:
+        if entry.obsolete:
+            strings_a_eliminar.append(entry)
+
+    for entry in strings_a_eliminar:
+        po.remove(entry)
+
+    # Guardar los cambios en el archivo .po
+    po.save()
+
+def po_clean():
+    """
+    Itera sobre los archivos .po y aplica la limpieza a cada uno
+    """
+    # Directorio donde se encuentran los archivos .po y sus subdirectorios
+    directorio_base = "docs/locales/es/LC_MESSAGES"
+
+    for root, _, archivos in os.walk(directorio_base):
+        for archivo in archivos:
+            if archivo.endswith(".po"):
+                ruta_completa = os.path.join(root, archivo)
+                eliminar_strings_obsoletos(ruta_completa)
+                print(f"Se han eliminado los strings obsoletos en {ruta_completa}")
+
+    print("Proceso completado. Los strings obsoletos han sido eliminados de los archivos .po.")
+
+if __name__ == "__main__":
+    po_clean()

potools/requirements.txt

@@ -0,0 +1,3 @@
+polib==1.2.0
+tabulate==0.9.0
+Jinja2==3.1.2

readme_update.py

@@ -0,0 +1,21 @@
+"""Modulo para actualizar el README.md"""
+
+from jinja2 import Environment, FileSystemLoader
+from potools.po_analizer import po_analize
+
+
+def actualizar_readme(table):
+    """
+    Obtiene información de los archivos .po y actualiza el archivo README.md
+    """
+    file_loader = FileSystemLoader('.')
+    env = Environment(loader=file_loader)
+
+    template = env.get_template('.github/README_template.md')
+
+    output = template.render(table=table)
+
+    with open('README.md', 'w', encoding='utf-8') as f:
+        f.write(output)
+
+actualizar_readme(po_analize())