https://github.com/ssciwr/clang-tidy-wheel
clang-tidy python wheels
https://github.com/ssciwr/clang-tidy-wheel
Last synced: 6 months ago
JSON representation
clang-tidy python wheels
- Host: GitHub
- URL: https://github.com/ssciwr/clang-tidy-wheel
- Owner: ssciwr
- License: apache-2.0
- Created: 2022-06-27T09:46:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-03T10:04:57.000Z (6 months ago)
- Last Synced: 2025-04-18T20:22:37.021Z (6 months ago)
- Language: Python
- Size: 188 KB
- Stars: 17
- Watchers: 2
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: COPYING.md
Awesome Lists containing this project
README
# clang-tidy Python distribution
[](https://pypi.org/project/clang-tidy)
This project packages the `clang-tidy` utility as a Python package. It allows you to install `clang-tidy` directly from PyPI:
```
python -m pip install clang-tidy
```
This projects intends to release a new PyPI package for each major and minor release of `clang-tidy`.
## Use with pipx
You can use `pipx` to run clang-tidy, as well. For example, `pipx run clang-tidy ` will run clang-tidy without any previous install required on any machine with pipx (including all default GitHub Actions / Azure runners, avoiding requiring a pre-install step or even `actions/setup-python`).
## Building new releases
The [clang-tidy-wheel repository](https://github.com/ssciwr/clang-tidy-wheel) provides the logic to build and publish binary wheels of the `clang-tidy` utility.
In order to add a new release, the following steps are necessary:
* Edit the [version file](https://github.com/ssciwr/clang-tidy-wheel/blob/main/clang-tidy_version.cmake) to reflect the new version.
* Make a GitHub release to trigger the [GitHub Actions release workflow](https://github.com/ssciwr/clang-tidy-wheel/actions/workflows/release.yml). Alternatively, the workflow can be triggered manually.
On manual triggers, the following input variables are available:
* `use_qemu`: Whether to build targets that require emulation (default: `true`)
* `llvm_version`: Override the LLVM version (default: `""`)
* `wheel_version`: Override the wheel packaging version (default `"0"`)
* `deploy_to_testpypi`: Whether to deploy to TestPyPI instead of PyPI (default: `false`)
The repository with the precommit hook is automatically updated using a scheduled Github Actions workflow.
## Acknowledgments
This repository extends the great work of several other projects:
* `clang-tidy` itself is [provided by the LLVM project](https://github.com/llvm/llvm-project) under the Apache 2.0 License with LLVM exceptions.
* The build logic is based on [scikit-build](https://github.com/scikit-build/scikit-build) which greatly reduces the amount of low level code necessary to package `clang-tidy`.
* The `scikit-build` packaging examples of [CMake](https://github.com/scikit-build/cmake-python-distributions) and [Ninja](https://github.com/scikit-build/ninja-python-distributions) were very helpful in packaging `clang-tidy`.
* The CI build process is controlled by [cibuildwheel](https://github.com/pypa/cibuildwheel) which makes building wheels across a number of platforms a pleasant experience (!)
We are grateful for the generous provisioning with CI resources that GitHub currently offers to Open Source projects.
## Troubleshooting
To see which clang-tidy binary the package is using
you can set `CLANG_TIDY_WHEEL_VERBOSE` to `1` in your environment.