A comprehensive Python library for checking HTML content against WCAG 2.2 accessibility guidelines

These details have not been verified by PyPI

Project links

Project description

WCAG Checker

A comprehensive Python library for checking HTML content against WCAG 2.2 accessibility guidelines.

Features

Full WCAG 2.2 Coverage: Checks against all 4 principles (Perceivable, Operable, Understandable, Robust) and 86+ success criteria
Multiple Conformance Levels: Target Level A, AA, or AAA compliance
Flexible Input: Check HTML strings or files
Detailed Reports: Generate reports in Text, JSON, HTML, or Markdown format
Actionable Feedback: Each issue includes recommendations and technique references

Installation

pip install wcag-checker

Or install from source:

git clone https://github.com/yourusername/wcag-checker
cd wcag-checker
pip install -e .

Quick Start

from wcag_checker import WCAGChecker, ConformanceLevel

# Create a checker
checker = WCAGChecker(level=ConformanceLevel.AA)

# Check HTML content
html = """
<!DOCTYPE html>
<html>
<body>
    <img src="logo.png">
    <a href="page.html">Click here</a>
</body>
</html>
"""

result = checker.check(html)

# View summary
print(result.summary())

# Iterate through issues
for issue in result.issues:
    print(f"[{issue.level.value}] {issue.criterion.id}: {issue.message}")

API Reference

WCAGChecker

The main class for checking HTML content.

from wcag_checker import WCAGChecker, ConformanceLevel

checker = WCAGChecker(
    level=ConformanceLevel.AA,      # Target conformance level (A, AA, or AAA)
    include_notices=True,            # Include informational notices
    enabled_criteria=None,           # Only run specific criteria (set of IDs)
    disabled_criteria=None,          # Skip specific criteria (set of IDs)
)

# Check HTML string
result = checker.check(html_string)

# Check HTML file
result = checker.check_file("path/to/file.html")

CheckResult

Contains the results of an accessibility check.

result = checker.check(html)

# Properties
result.issues          # List of Issue objects
result.checks_run      # Number of checks executed
result.is_compliant    # True if no errors found
result.level           # Target conformance level

# Methods
result.summary()                              # Get text summary
result.filter_by_level(IssueLevel.ERROR)     # Filter by severity
result.filter_by_criterion("1.1.1")          # Filter by WCAG criterion
result.filter_by_principle("perceivable")    # Filter by principle

Issue

Represents an accessibility issue found during checking.

for issue in result.issues:
    issue.criterion      # WCAGCriterion object
    issue.level          # IssueLevel (ERROR, WARNING, NOTICE)
    issue.message        # Description of the issue
    issue.element        # The problematic HTML element
    issue.selector       # CSS selector for the element
    issue.line           # Line number in source
    issue.context        # Surrounding HTML for context
    issue.recommendation # How to fix the issue
    issue.techniques     # WCAG technique references

Report Generation

Generate accessible reports in multiple formats.

from wcag_checker import Report, ReportFormat

result = checker.check(html)
report = Report(result)

# Generate different formats
text_report = report.to_text()
json_report = report.to_json()
html_report = report.to_html()
md_report = report.to_markdown()

# Save to file
report.save("report.html", ReportFormat.HTML)
report.save("report.json", ReportFormat.JSON)

Conformance Levels

Level A: Minimum level of conformance (most critical issues)
Level AA: Recommended for most websites (A + additional requirements)
Level AAA: Highest level of conformance (AA + additional requirements)

from wcag_checker import ConformanceLevel

# Check for Level A only
checker = WCAGChecker(level=ConformanceLevel.A)

# Check for Level AA (includes A)
checker = WCAGChecker(level=ConformanceLevel.AA)

# Check for Level AAA (includes A and AA)
checker = WCAGChecker(level=ConformanceLevel.AAA)

Issue Severity Levels

ERROR: Must be fixed for conformance
WARNING: Should be reviewed, likely needs fixing
NOTICE: Informational, may need manual verification

from wcag_checker import IssueLevel

# Get only errors
errors = result.filter_by_level(IssueLevel.ERROR)

# Exclude notices during checking
checker = WCAGChecker(include_notices=False)

Checks Included

Principle 1: Perceivable

1.1.1 Non-text Content (images, SVGs, objects)
1.2.1 Audio/Video alternatives
1.2.2 Captions for video
1.2.3 Audio descriptions
1.3.1 Info and Relationships (headings, tables, lists, forms)
1.3.5 Identify Input Purpose (autocomplete)
1.4.1 Use of Color
1.4.2 Audio Control

Principle 2: Operable

2.1.1 Keyboard Accessible
2.1.4 Character Key Shortcuts
2.2.1 Timing Adjustable (meta refresh)
2.2.2 Pause, Stop, Hide (blink, marquee)
2.3.1 Three Flashes (animated GIFs)
2.4.1 Bypass Blocks (skip links, landmarks)
2.4.2 Page Titled
2.4.4 Link Purpose
2.4.6 Headings and Labels
2.4.7 Focus Visible
2.5.3 Label in Name
2.5.7 Dragging Movements (WCAG 2.2)
2.5.8 Target Size (WCAG 2.2)

Principle 3: Understandable

3.1.1 Language of Page
3.1.2 Language of Parts
3.2.1 On Focus
3.2.2 On Input
3.2.6 Consistent Help (WCAG 2.2)
3.3.1 Error Identification
3.3.2 Labels or Instructions
3.3.7 Redundant Entry (WCAG 2.2)

Principle 4: Robust

4.1.1 Parsing (duplicate IDs, invalid nesting)
4.1.2 Name, Role, Value (buttons, iframes, ARIA)
4.1.3 Status Messages (live regions)

Command Line Usage

# Check a single file
python -m wcag_checker check page.html

# Check with specific level
python -m wcag_checker check page.html --level AAA

# Generate HTML report
python -m wcag_checker check page.html --format html --output report.html

Extending

You can create custom checks by extending the BaseCheck class:

from wcag_checker.checks.base import BaseCheck, register_check
from wcag_checker.criteria import SC_1_1_1

@register_check
class MyCustomCheck(BaseCheck):
    criterion = SC_1_1_1
    description = "My custom accessibility check"
    
    def check(self):
        issues = []
        # Your checking logic here
        for element in self.soup.find_all('my-element'):
            if not element.get('accessible-attr'):
                issues.append(Issue(
                    criterion=self.criterion,
                    level=IssueLevel.ERROR,
                    message="Missing accessible attribute",
                    element=str(element),
                    selector=self.get_element_selector(element),
                ))
        return issues

License

MIT License - see LICENSE file for details.

References

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

0.2.0

Apr 21, 2026

0.1.0

Apr 21, 2026

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wcag_checker-0.2.0.tar.gz (44.3 kB view details)

Uploaded Apr 21, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

wcag_checker-0.2.0-py3-none-any.whl (45.3 kB view details)

Uploaded Apr 21, 2026 Python 3

File details

Details for the file wcag_checker-0.2.0.tar.gz.

File metadata

Download URL: wcag_checker-0.2.0.tar.gz
Upload date: Apr 21, 2026
Size: 44.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wcag_checker-0.2.0.tar.gz
Algorithm	Hash digest
SHA256	`b45df7760c120e73470acf31897a70ab774261ad230ff4a0d2e9f1521017536d`
MD5	`5148bb6707d768cd4dd942f20c8777a7`
BLAKE2b-256	`1c5884369b1f294a25d0568e691053710ad07b107fb596ce1ab354f882569466`

See more details on using hashes here.

Provenance

The following attestation bundles were made for wcag_checker-0.2.0.tar.gz:

Publisher: publish.yml on voidstarr/wcag-checker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: wcag_checker-0.2.0.tar.gz
- Subject digest: b45df7760c120e73470acf31897a70ab774261ad230ff4a0d2e9f1521017536d
- Sigstore transparency entry: 1354763806
- Sigstore integration time: Apr 21, 2026
Source repository:
- Permalink: voidstarr/wcag-checker@31841e8f8766f891881f3ba1bd16cee4cd3dcc36
- Branch / Tag: refs/heads/main
- Owner: https://github.com/voidstarr
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@31841e8f8766f891881f3ba1bd16cee4cd3dcc36
- Trigger Event: push

File details

Details for the file wcag_checker-0.2.0-py3-none-any.whl.

File metadata

Download URL: wcag_checker-0.2.0-py3-none-any.whl
Upload date: Apr 21, 2026
Size: 45.3 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wcag_checker-0.2.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`3759f949c43eba34cea11b09c70dc5dc21a5eb11d08dc0ee8e2547bb0cdc56b8`
MD5	`060014d8b4b8dd04e2dbca0c4724d3e5`
BLAKE2b-256	`0554a85fb5d3fc473cd5ffaa5dda403d22fc0393bf5a3458ace8f0de193744ca`

See more details on using hashes here.

Provenance

The following attestation bundles were made for wcag_checker-0.2.0-py3-none-any.whl:

Publisher: publish.yml on voidstarr/wcag-checker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: wcag_checker-0.2.0-py3-none-any.whl
- Subject digest: 3759f949c43eba34cea11b09c70dc5dc21a5eb11d08dc0ee8e2547bb0cdc56b8
- Sigstore transparency entry: 1354763821
- Sigstore integration time: Apr 21, 2026
Source repository:
- Permalink: voidstarr/wcag-checker@31841e8f8766f891881f3ba1bd16cee4cd3dcc36
- Branch / Tag: refs/heads/main
- Owner: https://github.com/voidstarr
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@31841e8f8766f891881f3ba1bd16cee4cd3dcc36
- Trigger Event: push

wcag-checker 0.2.0

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

WCAG Checker

Features

Installation

Quick Start

API Reference

WCAGChecker

CheckResult

Issue

Report Generation

Conformance Levels

Issue Severity Levels

Checks Included

Principle 1: Perceivable

Principle 2: Operable

Principle 3: Understandable

Principle 4: Robust

Command Line Usage

Extending

License

References

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance