Publish JSON format (#54)

Co-authored-by: Stan Ulbrych <[email protected]>

Author: m-aciek

.github/workflows/update.yml

@@ -20,7 +20,7 @@ jobs:
       - uses: actions/checkout@v4
       - run: sudo apt-get install -y gettext
       - run: uv run generate.py  # generates "index.html"
-      - run: mkdir -p build && cp index.html style.css build
+      - run: mkdir -p build && cp index.* style.css build
       - name: Deploy 🚀
         if: github.event_name != 'pull_request'
         uses: JamesIves/github-pages-deploy-action@v4

completion.py

@@ -20,7 +20,7 @@ def branches_from_devguide(devguide_dir: Path) -> list[str]:
     ]
 
 
-def get_completion(clones_dir: str, repo: str) -> tuple[float, 'TranslatorsData']:
+def get_completion(clones_dir: str, repo: str) -> tuple[float, 'TranslatorsData', str]:
     clone_path = Path(clones_dir, repo)
     for branch in branches_from_devguide(Path(clones_dir, 'devguide')) + ['master']:
         try:
@@ -44,7 +44,7 @@ def get_completion(clones_dir: str, repo: str) -> tuple[float, 'TranslatorsData'
             hide_reserved=False,
             api_url='',
         ).completion
-    return completion, translators_data
+    return completion, translators_data, branch
 
 
 @dataclass(frozen=True)

generate.py

@@ -8,12 +8,13 @@
 #     "docutils",
 # ]
 # ///
+import json
 import concurrent.futures
 import itertools
 import logging
 import subprocess
 from collections.abc import Iterator
-from dataclasses import dataclass
+from dataclasses import dataclass, asdict
 from datetime import datetime, timezone
 from pathlib import Path
 from tempfile import TemporaryDirectory
@@ -48,6 +49,7 @@ def get_completion_progress() -> Iterator['LanguageProjectData']:
         subprocess.run(['make', '-C', cpython_dir / 'Doc', 'venv'], check=True)
         subprocess.run(['make', '-C', cpython_dir / 'Doc', 'gettext'], check=True)
         languages_built = dict(build_status.get_languages(http := PoolManager()))
+
         with concurrent.futures.ThreadPoolExecutor() as executor:
             return executor.map(
                 get_project_data,
@@ -67,7 +69,7 @@ def get_project_data(
 ) -> 'LanguageProjectData':
     built = language.code in languages_built
     if repo:
-        completion, translators_data = get_completion(clones_dir, repo)
+        completion, translators_data, branch = get_completion(clones_dir, repo)
         visitors_num = get_number_of_visitors(language.code, http) if built else 0
     else:
         completion = 0.0
@@ -76,6 +78,7 @@ def get_project_data(
     return LanguageProjectData(
         language,
         repo,
+        branch,
         completion,
         translators_data,
         visitors_num,
@@ -90,6 +93,7 @@ def get_project_data(
 class LanguageProjectData:
     language: Language
     repository: str | None
+    branch: str
     completion: float
     translators: TranslatorsData
     visitors: int
@@ -105,9 +109,12 @@ class LanguageProjectData:
     template = Template(Path('template.html.jinja').read_text())
 
     output = template.render(
-        completion_progress=list(get_completion_progress()),
+        completion_progress=(completion_progress := list(get_completion_progress())),
         generation_time=generation_time,
         duration=(datetime.now(timezone.utc) - generation_time).seconds,
     )
 
     Path('index.html').write_text(output)
+    Path('index.json').write_text(
+        json.dumps(completion_progress, indent=2, default=asdict)
+    )