cli

cli#

import compwa_policy.cli

Typer-based command-line interface for the developer-file checks.

This package gives check-dev-files a grouped subcommand structure under a short top-level policy command. You can see which commands are available by running

policy --help

The per-check modules in compwa_policy are unchanged; only the dispatch and option parsing live here. Running policy without a subcommand runs every check, exactly like the check-dev-files pre-commit hook.

run_everything(ctx: Context, python: Annotated[bool | None, <typer.models.OptionInfo object at 0x7f91d0ea9310>]=None, dev_python_version: 6', '3.7', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14'] | None, <typer.models.OptionInfo object at 0x7f91d16ec910>]=None, package_manager: Literal['none', 'uv', 'conda', 'pixi+uv', 'pixi', 'venv'] | None, <typer.models.OptionInfo object at 0x7f91d0eab4d0>]=None, repo_name: Annotated[str | None, <typer.models.OptionInfo object at 0x7f91d0eab9d0>]=None, repo_organization: Annotated[str | None, <typer.models.OptionInfo object at 0x7f91d0eabb10>]=None, repo_title: Annotated[str | None, <typer.models.OptionInfo object at 0x7f91d0eabc50>]=None, no_ruff: Annotated[bool | None, <typer.models.OptionInfo object at 0x7f91d0df0050>]=None, pytest_single_threaded: Annotated[bool | None, <typer.models.OptionInfo object at 0x7f91d0df0550>]=None, doc_apt_packages: Annotated[str | None, <typer.models.OptionInfo object at 0x7f91d0df1590>]=None) → None[source]#

Run every check at once (this is what the check-dev-files hook does).

Only the options shared across the whole repository are accepted here, mirroring the top-level [tool.compwa.policy] table. Options scoped to a single area are configured in the matching [tool.compwa.policy.<group>] sub-table, or passed to the corresponding subcommand (e.g. policy github --no-pypi).

get_click_command() → Command[source]#

Return the policy app as a Click command.

This bridges the Typer app to the Click layer so that the pwa command can mount it as a subcommand through a pwa.commands entry point, without either package depending on the other.

main() → None[source]#

Submodules and Subpackages