chore: save progress

Author: shenxianpeng

README.rst

@@ -34,6 +34,7 @@ clang-tools CLI
 Features
 --------
 
+- Support clang tools binaries and Python wheels.
 - Binaries are statically linked for improved portability.
 - Binaries can be specified installed for increased flexibility.
 - Binaries are checked with SHA512 checksum. This ensures:
@@ -50,6 +51,7 @@ Features
       category.
 - Customizable install path.
 
+
 Install clang-tools CLI
 -----------------------
 
@@ -85,14 +87,15 @@ Install `clang-tools` from git repo
 
     pip install git+https://github.com/cpp-linter/clang-tools-pip.git@main
 
+
 CLI Usage
 ---------
 
 For a list of supported Command Line Interface options, see
 `the CLI documentation <https://cpp-linter.github.io/clang-tools-pip/cli_args.html>`_
 
-Examples
-********
+Install binaries examples
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Use ``clang-tools`` command to install version 13 binaries.
 
@@ -128,17 +131,49 @@ If the installed directory is in your path, you can run the installed tools.
       Default target: x86_64-unknown-linux-gnu
       Host CPU: skylake
 
-Supported versions
+
+Install wheels examples
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+After installing the ``clang-tools`` CLI, you can install the Python wheels by running: ``clang-tools-wheel`` command.
+
+.. important::
+    It is just used for cpp-linter projects to install clang tools Python wheels. For other use cases, please install the wheels with ``pip``, ``pipx``, ``uv``, or other tools.
+
+
+.. code-block:: shell
+
+    # Install latest clang-format wheel
+    clang-tools-wheel --tool clang-format --version 21
+    # Install latest clang-tidy wheel
+    clang-tools-wheel --tool clang-tidy --version 21
+
+
+Supported Versions
 ------------------
 
-clang-format, clang-tidy, clang-query, clang-apply-replacements
-***************************************************************
+
+clang tools binaries
+~~~~~~~~~~~~~~~~~~~~
+
+The following table shows the supported versions of clang-format, clang-tidy, clang-query, and clang-apply-replacements binaries for each platform:
+
 .. csv-table::
-    :header: "Version", "21", "20", "19", "18", "17", "16", "15", "14", "13", "12", "11", "10", "9"
+    :header: "Platform", "21", "20", "19", "18", "17", "16", "15", "14", "13", "12", "11", "10", "9"
     :stub-columns: 1
 
     Linux,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️
     Windows,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️
     macOS,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️,✔️
 
 For more details, visit the `clang-tools-static-binaries <https://github.com/cpp-linter/clang-tools-static-binaries>`_ repository.
+
+clang tools Python wheels
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following Python wheels are supported:
+
+- `clang-format <https://pypi.org/project/clang-format/#history>`_
+- `clang-tidy <https://pypi.org/project/clang-tidy/#history>`_
+
+Check the respective PyPI pages for available versions and platform support.

clang_tools/wheel.py

@@ -2,7 +2,8 @@
 from cpp_linter_hooks.util import _resolve_install
 
 
-def main() -> int:
+def get_parser() -> ArgumentParser:
+    """Get and parser to interpret CLI args."""
     parser = ArgumentParser(description="Install specified clang tool wheel")
     parser.add_argument(
         "--tool",
@@ -15,6 +16,22 @@ def main() -> int:
         default=None,
         help="Version to install (e.g., 21 or 21.1.2). Defaults to latest compatible version.",
     )
+    return parser
+
+
+def main() -> int:
+    parser = get_parser()
+    args = parser.parse_args()
+    args = parser.parse_args()
+    path = _resolve_install(args.tool, args.version)
+    if path:
+        print(f"{args.tool} installed at: {path}")
+        return 0
+    parser.add_argument(
+        "--version",
+        default=None,
+        help="Version to install (e.g., 21 or 21.1.2). Defaults to latest compatible version.",
+    )
     args = parser.parse_args()
     path = _resolve_install(args.tool, args.version)
     if path:

docs/api.rst

@@ -9,3 +9,6 @@ API Reference
 
 .. automodule:: clang_tools.util
     :members:
+
+.. automodule:: clang_tools.wheel
+    :members:

docs/conf.py

@@ -14,6 +14,7 @@
 from sphinx.util.docutils import SphinxRole
 from sphinx_immaterial.inline_icons import load_svg_into_builder_env
 from clang_tools.main import get_parser
+from clang_tools.wheel import get_parser as get_wheel_parser
 
 # -- Path setup --------------------------------------------------------------
 
@@ -207,38 +208,49 @@ def setup(app: Sphinx):
     app.add_role("badge-default", CliBadgeDefault())
     app.add_role("badge-switch", CliBadgeSwitch())
 
+    def write_cli_doc(doc_path, parser, prog_name):
+        with open(doc_path, mode="w") as doc:
+            doc.write(f"{prog_name} --help\n{'=' * 30}\n\n")
+            doc.write(
+                ".. code-block:: text\n    :caption: Usage\n    :class: no-copy\n\n"
+            )
+            parser.prog = prog_name
+            str_buf = StringIO()
+            parser.print_usage(str_buf)
+            usage = str_buf.getvalue()
+            start = usage.find(parser.prog)
+            for line in usage.splitlines():
+                doc.write(f"    {line[start:]}\n")
+            args = parser._optionals._actions
+            for arg in args:
+                aliases = arg.option_strings
+                if not aliases or arg.default == "==SUPPRESS==":
+                    continue
+                assert arg.help is not None
+                doc.write("\n.. std:option:: " + ", ".join(aliases) + "\n")
+                req_ver = next(
+                    (
+                        ver
+                        for ver, names in REQUIRED_VERSIONS.items()
+                        if arg.dest in names
+                    ),
+                    "0.1.0",
+                )
+                doc.write(f"\n    :badge-version:`{req_ver}` ")
+                if arg.default:
+                    default = (
+                        " ".join(arg.default)
+                        if isinstance(arg.default, list)
+                        else arg.default
+                    )
+                    doc.write(f":badge-default:`{default}` ")
+                if isinstance(arg, _StoreTrueAction):
+                    doc.write(":badge-switch:`Accepts no value` ")
+                doc.write("\n\n    ")
+                doc.write("\n    ".join(arg.help.splitlines()) + "\n")
+
     cli_doc = Path(app.srcdir, "cli_args.rst")
-    with open(cli_doc, mode="w") as doc:
-        doc.write("Command Line Interface Options\n==============================\n\n")
-        parser = get_parser()
-        doc.write(".. code-block:: text\n    :caption: Usage\n    :class: no-copy\n\n")
-        parser.prog = "clang-tools"
-        str_buf = StringIO()
-        parser.print_usage(str_buf)
-        usage = str_buf.getvalue()
-        start = usage.find(parser.prog)
-        for line in usage.splitlines():
-            doc.write(f"    {line[start:]}\n")
-
-        args = parser._optionals._actions
-        for arg in args:
-            aliases = arg.option_strings
-            if not aliases or arg.default == "==SUPPRESS==":
-                continue
-            assert arg.help is not None
-            doc.write("\n.. std:option:: " + ", ".join(aliases) + "\n")
-            req_ver = "0.1.0"
-            for ver, names in REQUIRED_VERSIONS.items():
-                if arg.dest in names:
-                    req_ver = ver
-                    break
-            doc.write(f"\n    :badge-version:`{req_ver}` ")
-            if arg.default:
-                default = arg.default
-                if isinstance(arg.default, list):
-                    default = " ".join(arg.default)
-                doc.write(f":badge-default:`{default}` ")
-            if isinstance(arg, _StoreTrueAction):
-                doc.write(":badge-switch:`Accepts no value` ")
-            doc.write("\n\n    ")
-            doc.write("\n    ".join(arg.help.splitlines()) + "\n")
+    write_cli_doc(cli_doc, get_parser(), "clang-tools")
+
+    wheel_cli_doc = Path(app.srcdir, "wheel_cli_args.rst")
+    write_cli_doc(wheel_cli_doc, get_wheel_parser(), "clang-tools-wheel")

docs/index.rst

@@ -11,6 +11,7 @@
    :hidden:
 
    cli_args
+   wheel_cli_args
 
 .. toctree::
    :hidden:

docs/usage.rst

@@ -1,5 +1,5 @@
-Using a Custom Binary Repository
---------------------------------
+Custom Binary Repository
+------------------------
 
 You can override the default source for downloading **clang-tools** by setting the following environment variables:
 

docs/wheel_cli_args.rst

@@ -0,0 +1,20 @@
+clang-tools-wheel --help
+==============================
+
+.. code-block:: text
+    :caption: Usage
+    :class: no-copy
+
+    clang-tools-wheel [-h] [--tool {clang-format,clang-tidy}] [--version VERSION]
+
+.. std:option:: --tool
+
+    :badge-version:`0.11.0` :badge-default:`clang-format`
+
+    Tool to install (clang-format or clang-tidy)
+
+.. std:option:: --version
+
+    :badge-version:`0.1.0`
+
+    Version to install (e.g., 21 or 21.1.2). Defaults to latest compatible version.

pyproject.toml

@@ -39,7 +39,6 @@ dynamic = ["version"]
 
 [project.scripts]
 clang-tools = "clang_tools.main:main"
-clang-tools-binary = "clang_tools.main:main"
 clang-tools-wheel = "clang_tools.wheel:main"
 
 [project.urls]