generate license list from cargo tree

Author: 2bndy5

docs/docs/other-licenses.md

@@ -1,50 +1,5 @@
 # Third-party Licenses
 
-- [clap](https://crates.io/crates/clap):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [git2](https://crates.io/crates/git2):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-
-    The following are conditionally included in binaries (using the `openssl-vendored` feature on a
-    case-by-case basis) because it is a dependency of git2:
-
-    - [openssl](https://crates.io/crates/openssl): Licensed under [Apache 2.0][Apache2]
-    - [openssl-probe](https://crates.io/crates/openssl-probe):
-      Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-
-- [lenient_semver](https://crates.io/crates/lenient_semver):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [log](https://crates.io/crates/log):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [regex](https://crates.io/crates/regex):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [reqwest](https://crates.io/crates/reqwest):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [semver](https://crates.io/crates/semver):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [serde](https://crates.io/crates/serde):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [serde-xml-rs](https://crates.io/crates/serde-xml-rs): Licensed under [MIT].
-- [serde_json](https://crates.io/crates/serde_json):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [which](https://crates.io/crates/which): Licensed under [MIT].
-- [tokio](https://crates.io/crates/tokio): Licensed under [MIT].
-- [futures](https://crates.io/crates/futures):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [chrono](https://crates.io/crates/chrono):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-- [colored](https://crates.io/crates/colored): Licensed under [MPL-2.0]
-
-The python binding uses
-
-- [pyo3](https://crates.io/crates/pyo3):
-  Dual-licensed under [Apache 2.0][Apache2] or [MIT].
-
-The node binding uses
-
-- [napi](https://crates.io/crates/napi): Licensed under [MIT]
-- [napi-derive](https://crates.io/crates/napi-derive): Licensed under [MIT]
-
-[MIT]: https://choosealicense.com/licenses/mit
-[Apache2]: https://choosealicense.com/licenses/apache-2.0/
-[MPL-2.0]: https://choosealicense.com/licenses/mpl-2.0
+This page is generated when mkdocs builds.
+All content here is overwritten when building the docs.
+See [license_gen.py](../license_gen.py) to make changes to this doc.

docs/license_gen.py

@@ -0,0 +1,77 @@
+from pathlib import Path
+from typing import Dict, Any
+import yaml
+import mkdocs_gen_files
+from subprocess import run
+
+FILENAME = "other-licenses.md"
+
+INTRO = """# Third-party Licenses
+
+[MIT]: https://choosealicense.com/licenses/mit
+[Apache-2.0]: https://choosealicense.com/licenses/apache-2.0/
+[MPL-2.0]: https://choosealicense.com/licenses/mpl-2.0
+"""
+
+OPTIONAL_DEPS = """## Optional dependencies
+
+The following are conditionally included in binaries (using the `openssl-vendored`
+feature on a case-by-case basis) because it is a dependency of
+[git2](https://crates.io/crates/git2):
+
+
+- [openssl](https://crates.io/crates/openssl): Licensed under [Apache-2.0].
+- [openssl-probe](https://crates.io/crates/openssl-probe):
+  Dual-licensed under [Apache-2.0] or [MIT].
+"""
+
+BINDING_DEPS = """## Bindings' dependencies
+
+The python binding uses
+
+- [pyo3](https://crates.io/crates/pyo3):
+  Dual-licensed under [Apache-2.0] or [MIT].
+
+The node binding uses
+
+- [napi](https://crates.io/crates/napi): Licensed under [MIT]
+- [napi-derive](https://crates.io/crates/napi-derive): Licensed under [MIT]
+"""
+
+with mkdocs_gen_files.open(FILENAME, "w") as io_doc:
+    options_versions = Path(__file__).parent / "cli.yml"
+    versions: Dict[str, Any] = yaml.safe_load(options_versions.read_bytes())
+
+    print(INTRO, file=io_doc)
+    output = run(
+        [
+            "cargo",
+            "tree",
+            "-f",
+            r"[{p}]({r}): Licensed under {l}",
+            "-e",
+            "normal",
+            "-p",
+            "cpp-linter",
+            "--depth",
+            "1",
+        ],
+        capture_output=True,
+        check=True,
+    )
+    doc = "\n".join(
+        [
+            "- "
+            + line[3:]
+            .replace(" MIT", " [MIT]")
+            .replace(" Apache-2.0", " [Apache-2.0]")
+            .replace(" MPL-2.0", " [MPL-2.0]")
+            for line in output.stdout.decode(encoding="utf-8").splitlines()[1:]
+        ]
+    )
+    # print(doc)
+    print(doc, file=io_doc)
+    print(f"\n{OPTIONAL_DEPS}\n", file=io_doc)
+    print(f"\n{BINDING_DEPS}\n", file=io_doc)
+
+mkdocs_gen_files.set_edit_path(FILENAME, "license-gen.py")

docs/mkdocs.yml

@@ -79,6 +79,7 @@ plugins:
   - gen-files:
       scripts:
         - gen_cli_doc.py
+        - license_gen.py
 
 markdown_extensions:
   - pymdownx.superfences