check

check(path='.', **options)

Check a Python package for issues.

Configuration is loaded from pyproject.toml [tool.pycmdcheck] and merged with options passed to this function. Options override pyproject.toml.

Args: path: Path to the package directory (default: current directory) **options: Check options (profile, skip, only, error_on, etc.) - profile: Profile name (str) - skip_ids: Check IDs to skip (list[str]) - skip_groups: Check groups to skip (list[str]) - only_ids: Only run these check IDs (list[str]) - only_groups: Only run checks in these groups (list[str]) - error_on: Minimum severity causing exit code 1 (str: “error”, “warning”, “note”)

Returns: Results object with check outcomes