Redesign the dashboard

.github/workflows/update.yml

@@ -21,7 +21,6 @@ jobs:
       - run: sudo apt-get install -y gettext
       - run: pip install -r requirements.txt
       - run: uv run generate.py  # generates index.html and index.json
-      - run: mkdir -p build && cp index.* style.css build
       - name: Deploy 🚀
         if: github.event_name != 'pull_request'
         uses: JamesIves/github-pages-deploy-action@v4
@@ -55,10 +54,9 @@ jobs:
         if: github.event_name == 'pull_request'
         run: |
           curl -Lo index.html-public https://github.com/python-docs-translations/dashboard/raw/refs/heads/gh-pages/index.html
-          diff --color=always -u index.html-public index.html || :
-          cat index.html
+          diff --color=always -u index.html-public build/index.html || :
+          cat build/index.html
       - run: uv run generate_metadata.py  # generates metadata.html
-      - run: cp metadata.html warnings* build
       - name: Deploy metadata view 🚀
         if: github.event_name != 'pull_request'
         uses: JamesIves/github-pages-deploy-action@v4

build_status.py

@@ -11,7 +11,7 @@
 from urllib3 import PoolManager
 
 
-def get_languages(http: PoolManager) -> Iterator[tuple[str, bool]]:
+def get_languages(http: PoolManager) -> Iterator[tuple[str, str, bool]]:
     data = http.request(
         'GET',
         'https://raw.githubusercontent.com/python/docsbuild-scripts/refs/heads/main/config.toml',
@@ -20,12 +20,14 @@ def get_languages(http: PoolManager) -> Iterator[tuple[str, bool]]:
     for code, language in config['languages'].items():
         language_code = code.lower().replace('_', '-')
         in_switcher = language.get('in_prod', config['defaults']['in_prod'])
-        yield language_code, in_switcher
+        translated_name = language.get('translated_name')
+        yield language_code, translated_name, in_switcher
 
 
 def main() -> None:
     languages = {
-        language: in_switcher for language, in_switcher in get_languages(PoolManager())
+        language: in_switcher
+        for language, translated_name, in_switcher in get_languages(PoolManager())
     }
     print(languages)
     for code in ('en', 'pl', 'ar', 'zh-cn', 'id'):

build_warnings.py

@@ -33,5 +33,5 @@ def number(clones_dir: str, repo: str, language_code: str) -> int:
             f'./sphinxbuild/{language_code}',  # outputdir
         )
     )
-    copyfile(warning_file, f'warnings-{language_code}.txt')
+    copyfile(warning_file, f'build/warnings-{language_code}.txt')
     return len(findall('ERROR|WARNING', Path(warning_file).read_text()))

completion.py

@@ -3,7 +3,7 @@
 from functools import cache
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Literal
+from typing import Literal, List
 
 import git
 from potodo import potodo
@@ -36,13 +36,15 @@ def get_completion(
             )
         except git.GitCommandError:
             print(f'failed to clone {repo} {branch}')
-            translators_data = TranslatorsData(0, False)
+            translators_data = TranslatorsData(0, [], False)
             branch = ''
             continue
         else:
-            translators_number = translators.get_number(clone_path)
+            translators_list, translators_number = translators.get_number(clone_path)
             translators_link = translators.get_link(clone_path, repo, branch)
-            translators_data = TranslatorsData(translators_number, translators_link)
+            translators_data = TranslatorsData(
+                translators_number, translators_list, translators_link
+            )
             break
     path_for_merge = Path(clones_dir, 'rebased_translations', repo)
     completion = potodo.merge_and_scan_path(
@@ -83,4 +85,5 @@ def get_completion(
 @dataclass(frozen=True)
 class TranslatorsData:
     number: int
+    list: List
     link: str | Literal[False]

generate.py

@@ -6,10 +6,11 @@
 from collections.abc import Iterator
 from dataclasses import dataclass, asdict
 from datetime import datetime, timezone
+from typing import Any, Dict
 from pathlib import Path
 
 from git import Repo
-from jinja2 import Template
+from jinja2 import Environment, FileSystemLoader
 from urllib3 import PoolManager
 
 import build_status
@@ -37,7 +38,13 @@ 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(PoolManager()))
+
+    languages_built: Dict[str, Dict[str, Any]] = {
+        code: {'in_switcher': in_switcher, 'translated_name': translated_name}
+        for code, translated_name, in_switcher in build_status.get_languages(
+            PoolManager()
+        )
+    }
 
     with concurrent.futures.ThreadPoolExecutor() as executor:
         return executor.map(
@@ -51,17 +58,22 @@ def get_completion_progress() -> Iterator['LanguageProjectData']:
 def get_project_data(
     language: Language,
     repo: str | None,
-    languages_built: dict[str, bool],
+    languages_built: Dict[str, Dict[str, Any]],
     clones_dir: str,
 ) -> 'LanguageProjectData':
     built = language.code in languages_built
     if repo:
         completion, translators_data, branch, change = get_completion(clones_dir, repo)
     else:
         completion = 0.0
-        translators_data = TranslatorsData(0, False)
+        translators_data = TranslatorsData(0, [], False)
         change = 0.0
         branch = ''
+
+    language_data = languages_built.get(language.code, {})
+    translated_name = language_data.get('translated_name', '')
+    in_switcher = language_data.get('in_switcher', False)
+
     return LanguageProjectData(
         language,
         repo,
@@ -70,7 +82,8 @@ def get_project_data(
         change,
         translators_data,
         built,
-        in_switcher=languages_built.get(language.code),
+        translated_name=translated_name,
+        in_switcher=in_switcher,
         uses_platform=language.code in contribute.pulling_from_transifex,
         contribution_link=contribute.get_contrib_link(language.code, repo),
     )
@@ -85,6 +98,7 @@ class LanguageProjectData:
     change: float
     translators: TranslatorsData
     built: bool
+    translated_name: str
     in_switcher: bool | None
     uses_platform: bool
     contribution_link: str | None
@@ -93,16 +107,37 @@ class LanguageProjectData:
 if __name__ == '__main__':
     logging.basicConfig(level=logging.INFO)
     logging.info(f'starting at {generation_time}')
-    template = Template(Path('template.html.jinja').read_text())
+    Path('build').mkdir(parents=True, exist_ok=True)
+
+    completion_progress = list(get_completion_progress())
+    counts = get_counts(Path('clones', 'cpython', 'Doc', 'build', 'gettext'))
 
-    output = template.render(
-        completion_progress=(completion_progress := list(get_completion_progress())),
+    env = Environment(loader=FileSystemLoader('templates'))
+    index = env.get_template('index.html.jinja').render(
+        completion_progress=completion_progress,
         generation_time=generation_time,
         duration=(datetime.now(timezone.utc) - generation_time).seconds,
-        counts=get_counts(Path('clones', 'cpython', 'Doc', 'build', 'gettext')),
+        counts=counts,
     )
 
-    Path('index.html').write_text(output)
-    Path('index.json').write_text(
-        json.dumps(completion_progress, indent=2, default=asdict)
+    chart = env.get_template('chart.html.jinja').render(
+        completion_progress=completion_progress,
+        generation_time=generation_time,
+        duration=(datetime.now(timezone.utc) - generation_time).seconds,
+        counts=counts,
+    )
+
+    lang_template = env.get_template('language.html.jinja')
+    for project in completion_progress:
+        code = project.language.code
+        html = lang_template.render(project=project)
+        Path(f'build/{code}.html').write_text(html)
+
+    Path('build/style.css').write_bytes(Path('src/style.css').read_bytes())
+    Path('build/logo.png').write_bytes(Path('src/logo.png').read_bytes())
+    Path('build/index.html').write_text(index)
+    Path('build/chart.html').write_text(chart)
+
+    Path('build/index.json').write_text(
+        json.dumps([asdict(project) for project in completion_progress], indent=2)
     )

generate_metadata.py

@@ -9,7 +9,7 @@
 
 import dacite
 from git import Repo
-from jinja2 import Template
+from jinja2 import Environment, FileSystemLoader
 from urllib3 import request
 
 import build_warnings
@@ -55,20 +55,20 @@ def get_language_repo_and_completion(
 if __name__ == '__main__':
     logging.basicConfig(level=logging.INFO)
     logging.info(f'starting at {generation_time}')
-    template = Template(Path('metadata.html.jinja').read_text())
-    if (index_path := Path('index.json')).exists():
-        index_json = loads(Path('index.json').read_text())
+    env = Environment(loader=FileSystemLoader('templates'))
+    if (index_path := Path('build/index.json')).exists():
+        index_json = loads(Path('build/index.json').read_text())
     else:
         index_json = request('GET', argv[1]).json()
 
     completion_progress = [
         dacite.from_dict(LanguageProjectData, project) for project in index_json
     ]
 
-    output = template.render(
+    output = env.get_template('metadata.html.jinja').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)
+    Path('build/metadata.html').write_text(output)