Skip to content
a11y-lint

Python API

Quick scan

Section titled “Quick scan”
from a11y_lint import scan


messages = scan("ERROR: It failed")

Custom scanner

Section titled “Custom scanner”
from a11y_lint import Scanner


scanner = Scanner()
scanner.disable_rule("line-length")
messages = scanner.scan_text(text)

Create messages programmatically

Section titled “Create messages programmatically”
from a11y_lint import A11yMessage


msg = A11yMessage.error(
    code="APP001",
    what="Configuration file missing",
    why="The app cannot start without config.yaml",
    fix="Create config.yaml in the project root"
)

Validate against schema

Section titled “Validate against schema”
from a11y_lint import is_valid, validate_message


assert is_valid(msg)

Generate scorecard

Section titled “Generate scorecard”
from a11y_lint import create_scorecard


card = create_scorecard(messages)
print(card.summary())
print(f"Score: {card.overall_score}% ({card.overall_grade})")

Generate markdown report

Section titled “Generate markdown report”
from a11y_lint import render_report_md


markdown = render_report_md(messages, title="My Report")

Environment variables

Section titled “Environment variables”
VariableDescription
NO_COLORDisable colored output (any value)
FORCE_COLORForce colored output (any value)