Skip to main content

Portable accessibility checks with explicit manual-review boundaries.

Project description

accessibility-devkit for Python

A dependency-free Python 3.11+ package with the same commands, JSON contract, findings, and exit codes as @accessibility-devkit/cli.

python -m pip install accessibility-devkit

Run without keeping a global install:

pipx run accessibility-devkit scan ./index.html --profile all

Python API

from accessibility_devkit import (
    assess_time_limit,
    get_contrast_ratio,
    meets_contrast_threshold,
    scan_source,
)

ratio = get_contrast_ratio("#595959", "#ffffff")
passes = meets_contrast_threshold("#595959", "#ffffff")
timing = assess_time_limit({"adjustmentMultiplier": 10})
report = scan_source('<html lang="en"><main></main></html>', target="inline.html")

CLI

accessibility-devkit scan <files...> [--profile cvi|switch|all] [--format text|json]
accessibility-devkit contrast <foreground> <background> [--level AA|AAA] [--text-size normal|large]
accessibility-devkit readability <file|->
accessibility-devkit timing <policy.json>

Manual checks never fail CI. Static analysis does not replace browser, assistive-technology, or human verification; read each report's manualChecks before drawing a conclusion.

MIT © Luke Steuber.

Project details


Download files

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

Source Distribution

accessibility_devkit-1.1.1.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

accessibility_devkit-1.1.1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file accessibility_devkit-1.1.1.tar.gz.

File metadata

  • Download URL: accessibility_devkit-1.1.1.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for accessibility_devkit-1.1.1.tar.gz
Algorithm Hash digest
SHA256 c860b2ad284be1c1d5c288d8d594985050ce7d26034752c579c9ed5eba935fa1
MD5 efca35b7aea8e69f95cad6ef819efc16
BLAKE2b-256 8146f2212035fa3fb868498fcb8d6c34ecb5133ac99a8fffbb8b0d3fddc572ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for accessibility_devkit-1.1.1.tar.gz:

Publisher: release.yml on actually-useful-ai/accessibility-devkit

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

File details

Details for the file accessibility_devkit-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for accessibility_devkit-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6d98d1d40106ae0032285a4d622635f203d84a1536c6a4f815ebd3d95bc3e3f4
MD5 e3bd302e50a43e69b81566d9936e436e
BLAKE2b-256 13c04b8a9b38e5c605254372cbd30c699b8ce0e25326c52bb8ee0ea29f9c1efb

See more details on using hashes here.

Provenance

The following attestation bundles were made for accessibility_devkit-1.1.1-py3-none-any.whl:

Publisher: release.yml on actually-useful-ai/accessibility-devkit

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page