Python library to integrate axe and selenium for web accessibility testing.

Navigation

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for Knyght from gravatar.com Knyght Avatar for thibaudcolas from gravatar.com thibaudcolas

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Mozilla Public License 2.0 (MPL 2.0)
  • Author: Kimberly Sereduck
  • Tags axe-core , selenium , pytest-selenium , accessibility , automation , mozilla
  • Requires: Python >=3.12
  • Provides-Extra: lint
Report project as malware

Project description

axe-selenium-python integrates aXe and selenium to enable automated web accessibility testing.

This version of axe-selenium-python is using axe-core@4.10.2.

License PyPI Issues

Requirements

You will need the following prerequisites in order to use axe-selenium-python:

  • selenium >= 4.2

  • Python 3.12+

  • The appropriate driver for the browser you intend to use, downloaded and added to your path, e.g. geckodriver for Firefox:

Installation

To install axe-selenium-python:

$ pip install axe-selenium-python

Usage

from selenium import webdriver
from axe_selenium_python import Axe

def test_google():
    driver = webdriver.Firefox()
    driver.get("http://www.google.com")
    axe = Axe(driver)
    # Inject axe-core javascript into page.
    axe.inject()
    # Run axe accessibility checks.
    results = axe.run()
    # Write results to file
    axe.write_results(results, 'a11y.json')
    driver.close()
    # Assert no violations are found
    assert len(results["violations"]) == 0, axe.report(results["violations"])

The method axe.run() accepts two parameters: context and options.

For more information on context and options, view the aXe documentation here.

Contributing

Fork the repository and submit PRs with bug fixes and enhancements; contributions are very welcome.

Node dependencies must be installed by running npm install inside the axe-selenium-python directory.

You can run the tests using tox:

$ tox

CHANGELOG

version 3.0

  • Bumped minimum Python version to 3.12

  • Updated axe to axe-core@4.10.2

version 2.1.5

Breaks backwards compatibility:

  • The Axe class method execute has been renamed to run to mirror the method in the axe-core API.

version 2.1.0

  • Created package.json file to maintain axe-core dependency

  • Replaced unit tests with more meaningful integration tests - included a sample html file for integration tests

version 2.0.0

  • All functionalities that are not part of axe-core have been moved into a separate package, pytest-axe. This includes:

    • run_axe helper method

    • get_rules Axe class method

    • run Axe class method

    • impact_included Axe class method

    • analyze Axe class method.

The purpose of this change is to separate implementations that are specific to the Mozilla Firefox Test Engineering team, and leave the base axe-selenium-python package for a more broad use case. This package was modeled off of Deque’s Java package, axe-selenium-java, and will now more closely mirror it.

All functionalities can still be utilized when using axe-selenium-python in conjunction with pytest-axe.

version 1.2.3

  • Added the analyze method to the Axe class. This method runs accessibility checks, and writes the JSON results to file based on the page URL and the timestamp.

  • Writing results to file can be enabled by setting the environment variable ACCESSIBILITY_REPORTING=true. The files will be written to results/ directory, which must be created if it does not already exist.

  • Accessibility checks can be disabled by setting the environment variable ACCESSIBILITY_DISABLED=true.

version 1.2.1

  • Updated axe to axe-core@2.6.1

  • Modified impact_included class method to reflect changes to the aXe API:

  • There are now only 3 impact levels: ‘critical’, ‘serious’, and ‘minor’

version 1.0.0

  • Updated usage examples in README

  • Added docstrings to methods lacking documentation

  • Removed unused files

version 0.0.3

  • Added run method to Axe class to simplify the usage in existing test suites

  • run method includes the ability to set what impact level to test for: ‘minor’, ‘moderate’, ‘severe’, ‘critical’

version 0.0.28

  • Added selenium instance as a class attribute

  • Changed file paths to OS independent structure

  • Fixed file read operations to use with keyword

version 0.0.21

  • Fixed include of aXe API file and references to it

  • Updated README

Project details

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for Knyght from gravatar.com Knyght Avatar for thibaudcolas from gravatar.com thibaudcolas

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Mozilla Public License 2.0 (MPL 2.0)
  • Author: Kimberly Sereduck
  • Tags axe-core , selenium , pytest-selenium , accessibility , automation , mozilla
  • Requires: Python >=3.12
  • Provides-Extra: lint

Release history Release notifications | RSS feed

This version

3.0.0

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.2.4

1.2.3

1.2.2

1.2.1

1.1.7

1.1.6

1.1.5

1.1.4

1.1.2

1.1.1

1.1.0

1.0.100

1.0.0

0.0.450

0.0.441

0.0.289

0.0.287

0.0.286

0.0.276

0.0.275

0.0.274

0.0.273

0.0.272

0.0.271

0.0.270

0.0.269

0.0.268

0.0.44

0.0.43

0.0.35

0.0.32

0.0.31

0.0.28

0.0.21

0.0.3

0.0.2

0.0.0

Download files

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

Source Distribution

axe_selenium_python-3.0.0.tar.gz (222.6 kB view details)

Uploaded Source

Built Distribution

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

axe_selenium_python-3.0.0-py3-none-any.whl (160.6 kB view details)

Uploaded Python 3

File details

Details for the file axe_selenium_python-3.0.0.tar.gz.

File metadata

  • Download URL: axe_selenium_python-3.0.0.tar.gz
  • Upload date:
  • Size: 222.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for axe_selenium_python-3.0.0.tar.gz
Algorithm Hash digest
SHA256 8f082c821ce0c6c44a326a2df5bc5926c789d9b9600fbc052fb482ef20975513
MD5 e3f91d781251d9592868a954658d4d0c
BLAKE2b-256 e66b5e4b8d7725a83d88ec6bc4ab4c1d01d4fefbb3986017e947c02fb5fc3628

See more details on using hashes here.

Provenance

The following attestation bundles were made for axe_selenium_python-3.0.0.tar.gz:

Publisher: release.yml on django-commons/axe-selenium-python

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

File details

Details for the file axe_selenium_python-3.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for axe_selenium_python-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 847e3925861133a523609ff27d0fef387e7588a26f23a27c208a30682b8e9240
MD5 897537e92ff0f93b5d095a7057885fb4
BLAKE2b-256 e597ed2a5857ae31168a517d49a1c33dca2dfc41f5fd4c9beecd37871021f071

See more details on using hashes here.

Provenance

The following attestation bundles were made for axe_selenium_python-3.0.0-py3-none-any.whl:

Publisher: release.yml on django-commons/axe-selenium-python

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