Python library to integrate axe and selenium for web accessibility testing.
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@2.6.1.
Requirements
You will need the following prerequisites in order to use axe-selenium-python:
Python 2.7 or 3.6
pytest-selenium >= 3.0.0
geckodriver downloaded and added to your PATH
Optional
tox
Installation
To install axe-selenium-python:
$ pip install axe-selenium-python
To install pytest-axe:
$ pip install pytest-axe
Usage
test_accessibility.py
import pytest
@pytest.mark.nondestructive
def test_header_accessibility(axe):
violations = axe.run('header', None, 'critical')
assert len(violations) == 0, axe.report(violations)
The above example runs aXe against only the content within the <header> tag, and filters for violations labeled critical.
The method axe.run() accepts three parameters: context, options, and impact.
For more information on context and options, view the aXe documentation here.
The third parameter, impact, allows you to filter violations by their impact level. The options are 'critical', 'serious' and 'minor', with the default value set to None.
This will filter violations for the impact level specified, and all violations with a higher impact level.
To run the above test you will need to specify the browser instance to be invoked, and the base_url.
$ pytest --base-url http://www.mozilla.com --driver Firefox test_accessibility.py
Resources
CHANGELOG
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.min.js 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.276
Added pytest-axe usage example to README
version 0.0.275
Added usage example to README
version 0.0.273
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for axe_selenium_python-1.2.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ea88d305496437cc450b220de6da433050adf30793481f259c84e253b605c13 |
|
MD5 | cd4ed5492d29f554d8faab4edd59df44 |
|
BLAKE2b-256 | 9ddc18f3a769db30b5cbdc3cce7038f81918a6046dd2884c3c11a5d20fbd8616 |