Add metadata.html

Author: m-aciek

generate.py

@@ -25,7 +25,6 @@
 from jinja2 import Template
 from urllib3 import PoolManager
 
-import build_warnings
 import build_status
 import contribute
 from visitors import get_number_of_visitors
@@ -73,14 +72,10 @@ def get_project_data(
         visitors_num = (
             get_number_of_visitors(language.code, PoolManager()) if built else 0
         )
-        warnings = (
-            build_warnings.number(clones_dir, repo, language.code) if completion else 0
-        )
     else:
         completion = 0.0
         translators_data = TranslatorsData(0, False)
         visitors_num = 0
-        warnings = 0
         branch = None
     return LanguageProjectData(
         language,
@@ -89,7 +84,6 @@ def get_project_data(
         completion,
         translators_data,
         visitors_num,
-        warnings,
         built,
         in_switcher=languages_built.get(language.code),
         uses_platform=language.code in contribute.pulling_from_transifex,
@@ -105,7 +99,6 @@ class LanguageProjectData:
     completion: float
     translators: TranslatorsData
     visitors: int
-    warnings: int
     built: bool
     in_switcher: bool | None
     uses_platform: bool

generate_metadata.py

@@ -0,0 +1,92 @@
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "gitpython",
+#     "potodo",
+#     "jinja2",
+#     "requests",
+#     "docutils",
+#     "sphinx",
+#     "python-docs-theme",
+#     "dacite",
+# ]
+# ///
+import concurrent.futures
+import itertools
+import logging
+import subprocess
+from collections.abc import Iterator, Sequence
+from datetime import datetime, timezone
+from json import loads
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+import dacite
+from git import Repo
+from jinja2 import Template
+
+import build_warnings
+from completion import branches_from_devguide
+from generate import LanguageProjectData
+from repositories import Language
+
+generation_time = datetime.now(timezone.utc)
+
+
+def get_projects_metadata(
+    completion_progress: Sequence[LanguageProjectData],
+) -> Iterator[int]:
+    with TemporaryDirectory() as clones_dir:
+        Repo.clone_from(
+            'https://github.com/python/devguide.git',
+            devguide_dir := Path(clones_dir, 'devguide'),
+            depth=1,
+        )
+        latest_branch = branches_from_devguide(devguide_dir)[0]
+        Repo.clone_from(
+            'https://github.com/python/cpython.git',
+            cpython_dir := Path(clones_dir, 'cpython'),
+            depth=1,
+            branch=latest_branch,
+        )
+        subprocess.run(['make', '-C', cpython_dir / 'Doc', 'venv'], check=True)
+        subprocess.run(['make', '-C', cpython_dir / 'Doc', 'gettext'], check=True)
+        with concurrent.futures.ProcessPoolExecutor() as executor:
+            return executor.map(
+                get_metadata,
+                *zip(*map(get_language_repo_and_completion, completion_progress)),
+                itertools.repeat(clones_dir),
+            )
+
+
+def get_metadata(
+    language: Language, repo: str | None, completion: float, clones_dir: str
+) -> int:
+    return (
+        repo and completion and build_warnings.number(clones_dir, repo, language.code)
+    ) or 0
+
+
+def get_language_repo_and_completion(
+    project: LanguageProjectData,
+) -> tuple[Language, str | None, float]:
+    return project.language, project.repository, project.completion
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO)
+    logging.info(f'starting at {generation_time}')
+    template = Template(Path('metadata.html.jinja').read_text())
+
+    completion_progress = [
+        dacite.from_dict(LanguageProjectData, project)
+        for project in loads(Path('index.json').read_text())
+    ]
+
+    output = template.render(
+        metadata=zip(completion_progress, get_projects_metadata(completion_progress)),
+        generation_time=generation_time,
+        duration=(datetime.now(timezone.utc) - generation_time).seconds,
+    )
+
+    Path('metadata.html').write_text(output)

metadata.html.jinja

@@ -0,0 +1,32 @@
+<html lang="en">
+<head>
+  <title>Python Docs Translation Dashboard</title>
+  <link rel="stylesheet" href="style.css">
+  <meta charset="UTF-8">
+  <base target="_blank">
+</head>
+<body>
+<h1>Python Docs Translation Dashboard</h1>
+<table>
+<thead>
+<tr>
+  <th>language</th>
+  <th>build warnings*</th>
+</tr>
+</thead>
+<tbody>
+{% for project, metadata in metadata | sort(attribute='0.completion,0.translators.number') | reverse %}
+<tr>
+  <td data-label="language">{{ project.language.name }} ({{ project.language.code }})</td>
+  <td data-label="warnings">
+    {% if project.completion %}<a href="warnings-{{ project.language.code }}.txt">{{ metadata }}</a>{% else %}{{ metadata }}{% endif %}
+  </td>
+</tr>
+{% endfor %}
+</tbody>
+</table>
+<p>* number of Sphinx build process warnings</p>
+<p>For more information about translations, see the <a href="https://devguide.python.org/documentation/translating/">Python Developer’s Guide</a>.</p>
+<p>Last updated at {{ generation_time.strftime('%A, %-d %B %Y, %-H:%M:%S %Z') }} (in {{ duration // 60 }}:{{ "{:02}".format(duration % 60) }} minutes).</p>
+</body>
+</html>