axe-selenium-python-dev

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


Keywords
axe-core, selenium, pytest-selenium, accessibility, automation, mozilla
License
MPL-2.0
Install
pip install axe-selenium-python-dev==2.4.0

Documentation

axe-selenium-python-dev

axe-selenium-python-dev was forked from https://github.com/mozilla-services/axe-selenium-python on date 29/10/2020 all credits to them, there was no official pypi distribution available which supports axe-core 3.3.2 so took the opportunity to create this to support others like us

This version of axe-selenium-python-dev supports all changes in repo https://github.com/mozilla-services/axe-selenium-python before date 29/10/2020

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

License PyPI

Requirements

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

  • selenium >= 3.0.0
  • Python 2.7 or 3.6
  • 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-dev:

$ pip install axe-selenium-python-dev

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.

Resources

CHANGELOG

version 2.3.0

  • Axe-core node modules min file updated from 2.3.1 to 3.3.2

version 2.2.0

  • Axe-core node modules 3.3.2 path updated

version 2.1.0

  • Axe-core node modules 3.3.2 path updated

version 2.0.0

  • Axe-core node modules 3.3.2 updated

version 1.2.0

  • Updated to install node modules

version 1.1.1

  • Updated readme

version 1.1.0

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

version 1.0.0