C language utils and tools based on the clang and binutils modules.
Installation
Install clanguru using pipx for isolated installation:
pipx install clanguru
Usage
Clanguru provides four main commands for C/C++ code analysis and utility operations:
- Documentation: Generate (minimal) documentation for C/C++ sources functions and classes. It supports multiple output formats including Myst Markdown, standard Markdown, and RestructuredText.
- Testing: Create mock objects for unit testing C functions
- Analysis: Understand object file dependencies and symbol usage. It can generate HTML and Excel reports.
Check the help message for more details:
clanguru --help
Usage: clanguru [OPTIONS] COMMAND [ARGS]...
C language utils and tools based on the libclang module.
╭─ Options ────────────────────────────────────────────────────────────╮
│ --version -v Show version and exit. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────╮
│ docs Generate documentation for C/C++ source code. │
│ mock Generate mocks for C functions and variables. │
│ parse Parse C source code and print the translation unit. │
│ analyze Analyze object files dependencies. │
╰──────────────────────────────────────────────────────────────────────╯
For detailed help on each command, use the --help option with the command name.
clanguru analyze --help
Object File Analysis
Clanguru can analyze object files to understand their dependencies and symbol usage.
For this, you need to build your project and provide the compilation database (compile_commands.json).
Also, ensure that the nm command-line tool is available in your system PATH.
To generate an html dynamic dependency report, run the following command:
clanguru analyze --compilation-database compile_commands.json --output-file dependencies.html --use-parent-deps
[!NOTE] Here is the generated HTML report for my smart home temperature sensor project: https://maxiniuc.com/objects_deps/index.html. I only wrote some lines of code to make a temperature sensor available as a
matterdevice but the esp32 modules, matter stack, and all the libraries bring a lot of code and dependencies. 🫣 Feel free to move the nodes around and explore the dependencies.
If the output file ends with .xlsx, an Excel report will be generated instead of an HTML one.
Contributing
The project uses UV for dependencies management and packaging and the pypeline for streamlining the development workflow.
Use pipx (or your favorite package manager) to install the pypeline in an isolated environment:
pipx install pypeline-runner
To bootstrap the project and run all the steps configured in the pypeline.yaml file, execute the following command:
pypeline run
For those using VS Code there are tasks defined for the most common commands:
- run tests
- run pre-commit checks (linters, formatters, etc.)
- generate documentation
See the .vscode/tasks.json for more details.
1 maintainer
Metadata
1 maintainer
Release files for clanguru 0.21.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| clanguru-0.21.0.tar.gz | 42.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| clanguru-0.21.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 86.2 kB
Release files / clanguru-0.21.0.tar.gz
| Download URL | clanguru-0.21.0.tar.gz |
|---|---|
| Size | 42.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a13d9275aef37b6a87e4cd9c131c5fe7a31afeaeaff619b83cb8dbea667c448d
|
|
BLAKE2b-256 checksum How to use checksums |
8e83e4cf6f23ff4d2251d74a08480e20b164a7e074cecfab5fea5f3952c51427
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / clanguru-0.21.0-py3-none-any.whl
| Download URL | clanguru-0.21.0-py3-none-any.whl |
|---|---|
| Size | 43.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c9de23ad211be5275a2bd943216a8c0d2f1f9c63131de94eef6c9d23dc2e2a5
|
|
BLAKE2b-256 checksum How to use checksums |
53a0aaa4944711d5098a52cc60c9352f86a1c918456ca6452f4a8aa7c9521967
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency log
