|
| 1 | +import re |
| 2 | +from importlib.metadata import metadata, PackageNotFoundError |
| 3 | +from itertools import chain |
| 4 | +from pathlib import Path |
| 5 | +from textwrap import dedent |
| 6 | + |
| 7 | +import toml |
| 8 | +from jinja2 import StrictUndefined |
| 9 | +from jinja2.sandbox import SandboxedEnvironment |
| 10 | + |
| 11 | +project_dir = Path(".") |
| 12 | +pyproject = toml.load(project_dir / "pyproject.toml") |
| 13 | +project = pyproject["project"] |
| 14 | +pdm = pyproject["tool"]["pdm"] |
| 15 | +lock_data = toml.load(project_dir / "pdm.lock") |
| 16 | +lock_pkgs = {pkg["name"].lower(): pkg for pkg in lock_data["package"]} |
| 17 | +project_name = project["name"] |
| 18 | +regex = re.compile(r"(?P<dist>[\w.-]+)(?P<spec>.*)$") |
| 19 | + |
| 20 | +def get_license(pkg_name): |
| 21 | + try: |
| 22 | + data = metadata(pkg_name) |
| 23 | + except PackageNotFoundError: |
| 24 | + return "?" |
| 25 | + license = data.get("License", "").strip() |
| 26 | + multiple_lines = bool(license.count("\n")) |
| 27 | + # TODO: remove author logic once all my packages licenses are fixed |
| 28 | + author = "" |
| 29 | + if multiple_lines or not license or license == "UNKNOWN": |
| 30 | + for header, value in data.items(): |
| 31 | + if header == "Classifier" and value.startswith("License ::"): |
| 32 | + license = value.rsplit("::", 1)[1].strip() |
| 33 | + elif header == "Author-email": |
| 34 | + author = value |
| 35 | + if license == "Other/Proprietary License" and "pawamoy" in author: |
| 36 | + license = "ISC" |
| 37 | + return license or "?" |
| 38 | + |
| 39 | +def get_deps(base_deps): |
| 40 | + deps = {} |
| 41 | + for dep in base_deps: |
| 42 | + parsed = regex.match(dep).groupdict() |
| 43 | + dep_name = parsed["dist"].lower() |
| 44 | + deps[dep_name] = {"license": get_license(dep_name), **parsed, **lock_pkgs[dep_name]} |
| 45 | + |
| 46 | + again = True |
| 47 | + while again: |
| 48 | + again = False |
| 49 | + for pkg_name in lock_pkgs: |
| 50 | + if pkg_name in deps: |
| 51 | + for pkg_dependency in lock_pkgs[pkg_name].get("dependencies", []): |
| 52 | + parsed = regex.match(pkg_dependency).groupdict() |
| 53 | + dep_name = parsed["dist"].lower() |
| 54 | + if dep_name not in deps: |
| 55 | + deps[dep_name] = {"license": get_license(dep_name), **parsed, **lock_pkgs[dep_name]} |
| 56 | + again = True |
| 57 | + |
| 58 | + return deps |
| 59 | + |
| 60 | +dev_dependencies = get_deps(chain(*pdm.get("dev-dependencies", {}).values())) |
| 61 | +prod_dependencies = get_deps( |
| 62 | + chain( |
| 63 | + project.get("dependencies", []), |
| 64 | + chain(*project.get("optional-dependencies", {}).values()), |
| 65 | + ) |
| 66 | +) |
| 67 | + |
| 68 | +template_data = { |
| 69 | + "project_name": project_name, |
| 70 | + "prod_dependencies": sorted(prod_dependencies.values(), key=lambda dep: dep["name"]), |
| 71 | + "dev_dependencies": sorted(dev_dependencies.values(), key=lambda dep: dep["name"]), |
| 72 | + "more_credits": "http://pawamoy.github.io/credits/", |
| 73 | +} |
| 74 | +template_text = dedent( |
| 75 | + """ |
| 76 | + These projects were used to build `{{ project_name }}`. **Thank you!** |
| 77 | +
|
| 78 | + [`python`](https://www.python.org/) | |
| 79 | + [`pdm`](https://pdm.fming.dev/) | |
| 80 | + [`copier-pdm`](https://github.com/pawamoy/copier-pdm) |
| 81 | +
|
| 82 | + {% macro dep_line(dep) -%} |
| 83 | + [`{{ dep.name }}`](https://pypi.org/project/{{ dep.name }}/) | {{ dep.summary }} | {{ ("`" ~ dep.spec ~ "`") if dep.spec else "" }} | `{{ dep.version }}` | {{ dep.license }} |
| 84 | + {%- endmacro %} |
| 85 | +
|
| 86 | + ### Runtime dependencies |
| 87 | +
|
| 88 | + Project | Summary | Version (accepted) | Version (last resolved) | License |
| 89 | + ------- | ------- | ------------------ | ----------------------- | ------- |
| 90 | + {% for dep in prod_dependencies -%} |
| 91 | + {{ dep_line(dep) }} |
| 92 | + {% endfor %} |
| 93 | +
|
| 94 | + ### Development dependencies |
| 95 | +
|
| 96 | + Project | Summary | Version (accepted) | Version (last resolved) | License |
| 97 | + ------- | ------- | ------------------ | ----------------------- | ------- |
| 98 | + {% for dep in dev_dependencies -%} |
| 99 | + {{ dep_line(dep) }} |
| 100 | + {% endfor %} |
| 101 | +
|
| 102 | + {% if more_credits %}**[More credits from the author]({{ more_credits }})**{% endif %} |
| 103 | + """ |
| 104 | +) |
| 105 | +jinja_env = SandboxedEnvironment(undefined=StrictUndefined) |
| 106 | +print(jinja_env.from_string(template_text).render(**template_data)) |
0 commit comments