Sa11y
The Selenium Accessibility Package
Get basic accessibility information using the axe-core npm library on websites visited using Selenium.
Contact Deque for more information about axe™ functionality and results.
Note: This project does not support all of the features available in axe™, but is provided for the flexibility and convenience of Ruby users.
Prerequisites
Install python
Install pip
Install npm
Installing
$ pip install sa11y
Usage
Just pass in a valid driver instance to the Analyze class constructor and call the #results method.
driver = webdriver.Chrome() Analyze(driver).results()
By default, sa11y inspects elements in all frames and iframes on the page. If your site does not use frames, you can improve performance slightly by turning off frame checks:
driver = webdriver.Chrome() analyze = Analyze(driver, frames=false) analyze.results()
By default, sa11y does not inspect frames from cross origins. If you need to analyze frames originating from a different domain, you need to turn this on:
driver = webdriver.Chrome() analyze = Analyze(driver, cross_origin=false) analyze.results()
This gem comes packaged with the latest axe™ version at release. If you want to change this, specify the JS library you want to use:
driver = webdriver.Chrome() js_lib = open(“tests/resources/old.axe.min.js”, “r”).read() Analyze(driver, js_lib=js_lib).results()
Development
This project will be developed in Python 3.x so please create a virtual environment:
python3 -m venv venv
source venv/bin/activate
To install dependencies, do the following:
pip install -r requirements.txt
To install required scripts:
python setup.py npm_install
Deployment
The project needs to include a dynamically generated axe.min.js file, and can be built with this command:
python setup.py npm_install install sdist
- To release, makes sure you have twine installed and run:
twine upload -r pypi dist/*
Contributing
Please read [CONTRIBUTING.md](../CONTRIBUTING.md) for details on our process for submitting pull requests to us, and please ensure you follow the [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md).
Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/saucelabs/sa11y/tags).
License and Copyright
This project is licensed under the MPL-2.0 License - see the [LICENSE.md](LICENSE.md) file for details Copyright (c) 2021 Sauce Labs
Acknowledgments
Thanks to [@dequelabs](https://github.com/dequelabs) for their contributions to accessibility with the axe™ project
Thanks to [@seleniumhq](https://github.com/seleniumhq) for their contributions to browser automation with the Selenium project
Testing
To run all tests, run the following:
pytest
Metadata
Release files for sa11y 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sa11y-0.2.3-py3-none-any.whl | Python 3 | none | any | Details for sa11y-0.2.3-py3-none-any.whl |
Release files / sa11y-0.2.3-py3-none-any.whl
| Download URL | sa11y-0.2.3-py3-none-any.whl |
|---|---|
| Size | 114.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7ffa3b41b57f1d69955bb14384e6f145853e2df3250b29818e8797e71925af69
|
|
BLAKE2b-256 checksum How to use checksums |
8c61adc52114868600760c73ef5160fb61a3d192385814049857a7146a03bd21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
|
Security for sa11y 0.2.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.