Index

core

Core audit functionality.

audit_project(project_path, category=None, quick=False, framework=None)

Audit a project against its ecosystem's 2026 standards.

Rules execute in parallel via ThreadPoolExecutor for speed. Each rule is isolated — one failure does not prevent others. An ASTCache is shared across rules to avoid redundant parsing.

Parameters:

Name	Type	Description	Default
project_path	Path	Root directory of the project to audit.	required
category	str | None	Optional category filter.	None
quick	bool	If True, run only lint + type checks.	False
framework	Framework | str | None	Ecosystem to audit against. None auto-detects from the project's manifest markers (:func:detect_framework); pass an explicit value to override.	None

Returns:

Type	Description
AuditResult	AuditResult containing all check results.

Raises:

Type	Description
FileNotFoundError	If project_path does not exist.

Source code in packages/axm-audit/src/axm_audit/core/auditor.py

def audit_project(
    project_path: Path,
    category: str | None = None,
    quick: bool = False,
    framework: Framework | str | None = None,
) -> AuditResult:
    """Audit a project against its ecosystem's 2026 standards.

    Rules execute in parallel via ThreadPoolExecutor for speed.
    Each rule is isolated — one failure does not prevent others.
    An ``ASTCache`` is shared across rules to avoid redundant parsing.

    Args:
        project_path: Root directory of the project to audit.
        category: Optional category filter.
        quick: If True, run only lint + type checks.
        framework: Ecosystem to audit against. ``None`` auto-detects from the
            project's manifest markers (:func:`detect_framework`); pass an
            explicit value to override.

    Returns:
        AuditResult containing all check results.

    Raises:
        FileNotFoundError: If project_path does not exist.
    """
    if not project_path.exists():
        raise FileNotFoundError(f"Project path does not exist: {project_path}")

    fw = detect_framework(project_path) if framework is None else Framework(framework)

    workspace_packages = iter_workspace_packages(project_path)
    if workspace_packages:
        return _audit_workspace(
            project_path, workspace_packages, category=category, quick=quick
        )

    rules = get_rules_for_category(category, quick, framework=fw)

    cache = ASTCache()
    token = set_ast_cache(cache)
    try:
        with concurrent.futures.ThreadPoolExecutor() as pool:
            futures = [
                pool.submit(
                    contextvars.copy_context().run, _safe_check, rule, project_path
                )
                for rule in rules
            ]
            checks = [f.result() for f in futures]
    finally:
        reset_ast_cache(token)

    return AuditResult(project_path=str(project_path), checks=checks)

get_rules_for_category(category, quick=False, framework=Framework.PYTHON)

Get rules for a specific category or all rules, scoped to framework.

Parameters:

Name	Type	Description	Default
category	str | None	Filter to specific category, or None for all.	required
quick	bool	If True, only lint + type checks.	False
framework	Framework	Ecosystem whose rules to return (default python keeps the historical behaviour for callers that don't pass it).	PYTHON

Returns:

Type	Description
list[ProjectRule]	List of rule instances to run.

Raises:

Type	Description
ValueError	If category is not valid.

Source code in packages/axm-audit/src/axm_audit/core/auditor.py

def get_rules_for_category(
    category: str | None,
    quick: bool = False,
    framework: Framework = Framework.PYTHON,
) -> list[ProjectRule]:
    """Get rules for a specific category or all rules, scoped to *framework*.

    Args:
        category: Filter to specific category, or None for all.
        quick: If True, only lint + type checks.
        framework: Ecosystem whose rules to return (default ``python`` keeps
            the historical behaviour for callers that don't pass it).

    Returns:
        List of rule instances to run.

    Raises:
        ValueError: If category is not valid.
    """
    _ensure_registry_loaded()

    if quick:
        from axm_audit.core.rules.quality_rules import LintingRule, TypeCheckRule

        return [LintingRule(), TypeCheckRule()]

    # Validate category
    if category is not None and category not in VALID_CATEGORIES:
        raise ValueError(
            f"Invalid category: {category}. "
            f"Valid categories: {', '.join(sorted(VALID_CATEGORIES))}"
        )

    if not category:
        return _build_all_rules(framework)

    rule_classes = _merged_registry(framework).get(category, [])
    rules: list[ProjectRule] = []
    for cls in rule_classes:
        rules.extend(cls.get_instances())
    return rules