Skip to content

Audit

audit

AuditTool — code quality audit as an AXMTool.

AuditTool

Bases: AXMTool

Audit a project's code quality against the AXM standard.

Registered as audit via axm.tools entry point.

Source code in packages/axm-audit/src/axm_audit/tools/audit.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class AuditTool(AXMTool):
    """Audit a project's code quality against the AXM standard.

    Registered as ``audit`` via axm.tools entry point.
    """

    @property
    def name(self) -> str:
        """Return tool name for registry lookup."""
        return "audit"

    def execute(
        self,
        *,
        path: str = ".",
        category: str | None = None,
        **kwargs: Any,
    ) -> ToolResult:
        """Audit a Python project's code quality.

        Args:
            path: Path to project root.
            category: Optional category filter.

        Returns:
            ToolResult with audit scores and details.
        """
        try:
            project_path = Path(path).resolve()
            if not project_path.is_dir():
                return ToolResult(
                    success=False, error=f"Not a directory: {project_path}"
                )

            from axm_audit.core.auditor import audit_project
            from axm_audit.formatters import format_agent

            result = audit_project(project_path, category=category)
            return ToolResult(success=True, data=format_agent(result))
        except Exception as exc:  # noqa: BLE001
            return ToolResult(success=False, error=str(exc))
name property

Return tool name for registry lookup.

execute(*, path='.', category=None, **kwargs)

Audit a Python project's code quality.

Parameters:

Name Type Description Default
path str

Path to project root.

 '.'
category str | None

Optional category filter.

 None

Returns:

Type Description
ToolResult

ToolResult with audit scores and details.
Source code in packages/axm-audit/src/axm_audit/tools/audit.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def execute(
    self,
    *,
    path: str = ".",
    category: str | None = None,
    **kwargs: Any,
) -> ToolResult:
    """Audit a Python project's code quality.

    Args:
        path: Path to project root.
        category: Optional category filter.

    Returns:
        ToolResult with audit scores and details.
    """
    try:
        project_path = Path(path).resolve()
        if not project_path.is_dir():
            return ToolResult(
                success=False, error=f"Not a directory: {project_path}"
            )

        from axm_audit.core.auditor import audit_project
        from axm_audit.formatters import format_agent

        result = audit_project(project_path, category=category)
        return ToolResult(success=True, data=format_agent(result))
    except Exception as exc:  # noqa: BLE001
        return ToolResult(success=False, error=str(exc))