update_docs.py

import json
import pickle
import subprocess
from argparse import ArgumentParser
from collections import Counter
from datetime import date
from pathlib import Path

import matplotlib.pyplot as plt
import requests
import seaborn as sns
import urllib3
from bs4 import BeautifulSoup
from tqdm import tqdm

parser = ArgumentParser(
    prog="UpdateDocs",
    description="A helper script to update docs",
)
parser.add_argument("-f", "--force", action="store_true")
args, _ = parser.parse_known_args()
force = args.force

urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
folders = ["easy", "medium", "hard"]
language_map = {
    "py": "Python",
    "cpp": "C++",
    "java": "Java",
    "rs": "Rust",
    "go": "Go",
    "hs": "Haskell",
    "js": "JavaScript",
    "kt": "Kotlin",
}
summary = {}
all_files = []

try:
    with open("docs/.cache", "rb") as f:
        cache = pickle.load(f)
except:
    cache = {}

for folder in folders:
    uri = f"src/{folder}"
    if not Path(uri).exists():
        Path(uri).mkdir(exist_ok=True)

    files = list(Path(uri).glob("*"))
    solutions = {}

    for file in files:
        if file.stem not in solutions:
            solutions[file.stem] = [file.name]
        else:
            solutions[file.stem].append(file.name)
        all_files.append(file.name)

    total = len(solutions)
    summary[folder] = total

    if not force and set(solutions.keys()) < set(cache.keys()):
        print(f"⛔ Skipped {uri}: no update needed")
        print()
        continue

    try:
        subprocess.call(
            [
                "black",
                uri,
            ]
        )
    except:
        pass
    try:
        subprocess.call(
            [
                "clang-format",
                "-i",
                f"{Path('src')/folder/'*.cpp'}",
                "-style=Microsoft",
            ]
        )
    except:
        pass

    s = "s" if total > 1 else ""
    print()
    print(f"🔍 Found {total} solution{s} from {uri}")
    print()

    now = date.today()
    text = """---
hide:
  - toc
---
"""
    text += f"""
# Difficulty - {folder.capitalize()} (as of {now})
"""
    prompt = "📖 Refreshing Docs"
    for solution, languages in tqdm(sorted(solutions.items()), desc=prompt):
        url = f"https://open.kattis.com/problems/{solution}"
        if solution in cache:
            name = cache[solution]
        else:
            html = requests.get(url, verify=False)
            soup = BeautifulSoup(html.content, "html.parser")
            name = soup.find("h1").text
            cache[solution] = name
        if len(languages) > 1:
            suffix = f"s in {len(languages)} languages"
        else:
            ext = languages[0].split(".")[-1]
            suffix = f" in {language_map[ext]}"
        card = f"""
## [{name}]({url})

??? success "Solution{suffix}"
"""
        for language in sorted(languages):
            ext = language.split(".")[-1]
            card += f"""
    === "{language_map[ext]}"

        ```{ext} linenums="1"
        --8<-- "{uri}/{language}"
        ```
"""
        text += card

    print()

    with open(f"docs/{folder}.md", "w", encoding="utf-8") as f:
        f.write(text)

with open(".all-contributorsrc") as f:
    data = json.load(f)
    num_contributors = len(data["contributors"])

with open("docs/index.md", "w") as f:
    text = """
<figure markdown>
![Logo](https://open.kattis.com/images/site-logo){ width="100" }
</figure>

# Kattis

## Summary by Difficulty
"""

    for folder, total in summary.items():
        text += f"""
- [{folder.capitalize()} ^{total}^]({folder}.md)
"""
    text += f"""
## Summary by Initial

![summary-by-initial](summary-by-initial.png)

## Summary by Language

![summary-by-language](summary-by-language.png)

---

!!! note ""

    Thanks to all {num_contributors} [contributors](https://github.com/coding-armadillo/kattis#contributors-).
"""
    f.write(text.lstrip())

with open("docs/.cache", "wb") as f:
    pickle.dump(cache, f)

s = dict(Counter([k[0] for k in cache.values()]).most_common())
ax = sns.barplot(x=list(s.keys()), y=list(s.values()))
ax.get_figure().savefig("docs/summary-by-initial.png", bbox_inches="tight")

plt.clf()

s = dict(Counter([language_map[f.split(".")[-1]] for f in all_files]).most_common())
ax = sns.barplot(x=list(s.keys()), y=list(s.values()))
ax.set_xticklabels(ax.get_xticklabels(), rotation=45)
ax.get_figure().savefig("docs/summary-by-language.png", bbox_inches="tight")