|
| 1 | +"""Generate the credits page.""" |
| 2 | + |
| 3 | +import functools |
| 4 | +import re |
| 5 | +from itertools import chain |
| 6 | +from pathlib import Path |
| 7 | +from urllib.request import urlopen |
| 8 | + |
| 9 | +import mkdocs_gen_files |
| 10 | +import toml |
| 11 | +from jinja2 import StrictUndefined |
| 12 | +from jinja2.sandbox import SandboxedEnvironment |
| 13 | + |
| 14 | + |
| 15 | +def get_credits_data() -> dict: |
| 16 | + """Return data used to generate the credits file. |
| 17 | +
|
| 18 | + Returns: |
| 19 | + Data required to render the credits template. |
| 20 | + """ |
| 21 | + project_dir = Path(__file__).parent.parent |
| 22 | + metadata = toml.load(project_dir / "pyproject.toml")["project"] |
| 23 | + metadata_pdm = toml.load(project_dir / "pyproject.toml")["tool"]["pdm"] |
| 24 | + lock_data = toml.load(project_dir / "pdm.lock") |
| 25 | + project_name = metadata["name"] |
| 26 | + |
| 27 | + all_dependencies = chain( |
| 28 | + metadata.get("dependencies", []), |
| 29 | + chain(*metadata.get("optional-dependencies", {}).values()), |
| 30 | + chain(*metadata_pdm.get("dev-dependencies", {}).values()), |
| 31 | + ) |
| 32 | + direct_dependencies = {re.sub(r"[^\w-].*$", "", dep) for dep in all_dependencies} |
| 33 | + direct_dependencies = {dep.lower() for dep in direct_dependencies} |
| 34 | + indirect_dependencies = {pkg["name"].lower() for pkg in lock_data["package"]} |
| 35 | + indirect_dependencies -= direct_dependencies |
| 36 | + |
| 37 | + return { |
| 38 | + "project_name": project_name, |
| 39 | + "direct_dependencies": sorted(direct_dependencies), |
| 40 | + "indirect_dependencies": sorted(indirect_dependencies), |
| 41 | + "more_credits": "http://pawamoy.github.io/credits/", |
| 42 | + } |
| 43 | + |
| 44 | + |
| 45 | +@functools.lru_cache(maxsize=None) |
| 46 | +def get_credits(): |
| 47 | + """Return credits as Markdown. |
| 48 | +
|
| 49 | + Returns: |
| 50 | + The credits page Markdown. |
| 51 | + """ |
| 52 | + jinja_env = SandboxedEnvironment(undefined=StrictUndefined) |
| 53 | + commit = "c78c29caa345b6ace19494a98b1544253cbaf8c1" |
| 54 | + template_url = f"https://raw.githubusercontent.com/pawamoy/jinja-templates/{commit}/credits.md" |
| 55 | + template_data = get_credits_data() |
| 56 | + template_text = urlopen(template_url).read().decode("utf8") # noqa: S310 |
| 57 | + return jinja_env.from_string(template_text).render(**template_data) |
| 58 | + |
| 59 | + |
| 60 | +with mkdocs_gen_files.open("credits.md", "w") as fd: |
| 61 | + fd.write(get_credits()) |
| 62 | +mkdocs_gen_files.set_edit_path("credits.md", "gen_credits.py") |
0 commit comments