API Reference
Full API documentation is generated automatically from source code docstrings using pdoc.
Generating API Docs
This produces HTML documentation in the _pdoc/ directory.
Package Structure
rhiza_tools/
├── __init__.py # Package metadata and version
├── __main__.py # Entry point (Typer app)
├── cli.py # CLI command definitions
├── config.py # Configuration loading
└── commands/
├── analyze_benchmarks.py # Benchmark analysis & visualization
├── bump.py # Version bumping (semver)
├── generate_badge.py # Coverage badge generation
├── release.py # Release tag management
├── update_readme.py # README synchronization
└── version_matrix.py # Python version matrix
Key Modules
rhiza_tools.cli
The main Typer application. Defines all CLI commands and their option parsing.
rhiza_tools.config
Configuration loading from pyproject.toml and the Rhiza config file.
rhiza_tools.commands
Each command module exposes a single *_command() function that contains the
core logic, making commands testable independently of the CLI layer.
| Module | Entry Function |
|---|---|
analyze_benchmarks |
analyze_benchmarks_command() |
bump |
bump_command() |
generate_badge |
generate_coverage_badge_command() |
release |
release_command() |
update_readme |
update_readme_command() |
version_matrix |
version_matrix_command() |