Skip to content

Commit 688acf1

Browse files
* correct indentation
* added package.json to manage axe-core updates more easily * updated setup.py and MANIFEST.in to include new axe.js file, and the sample page for test * adding pypi deployment to travis * moved changelog into readme to fix file not found error
1 parent c957704 commit 688acf1

File tree

12 files changed

+133
-88
lines changed

12 files changed

+133
-88
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ __pycache__
1515
*.log
1616
assets/
1717
*.json
18+
!axe_selenium_python/package.json
19+
!axe_selenium_python/package-lock.json
1820
build/
1921
update.sh
20-
results/
22+
node_modules

.travis.yml

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
sudo: required
22
language: python
33
services:
4-
- docker
4+
- docker
55
jobs:
66
include:
7-
- stage:
8-
env:
9-
- TOXENV=flake8
10-
- stage:
11-
env: TOXENV=py27
12-
- stage:
13-
env:
14-
- TOXENV=py36
7+
- stage:
8+
env:
9+
- TOXENV=flake8
10+
- stage:
11+
env: TOXENV=py27
12+
- stage:
13+
env:
14+
- TOXENV=py36
1515
cache:
1616
pip: true
1717
before_install: docker build -t axe-selenium-python .
1818
install: skip
1919
script:
20-
- docker run -e TOXENV=$TOXENV axe-selenium-python tox
20+
- docker run -e TOXENV=$TOXENV axe-selenium-python tox
2121
notifications:
2222
email: fte-ci@mozilla.com
23+
2324
deploy:
2425
provider: pypi
2526
user: kimberlythegeek
2627
password:
27-
secure: RdrIO3QXePssZ/5cTOCwOMvpx0Jv9fDehCukU5fGy22NCV6pqcHRYJVp+hmCx4Mtkk20d1zpNUHZ+7EtvWneetlAwKlt/JwpzSWldwjZOp15SITkYN/Dw8ncXSyXQwrVcgkulgRh2jKGWvcEIAQ2T6dK07hoJB7afwqoZPGWQDUk9tlp+NJJEttlcDe0bw/zGYNPB7hmG/1eAX6gREkb6rjQhiZyrypKWuy4T/jvUTlaFRETR/2si0q0Pgfccj37A0ltRX8sEiFZVANI3rAJqVfiAe8Gx/O1uTJApDF35XcsSMvbhQKUOHH/es9eXm+6H08BsMdtLnTkEYzqYGIE94bnQTiflJcrBueypLUxU7Fgq4/Kb70zRtsJplp8nbmrMoqs/dWzlwTNMC55UMlwyJkkrllwK/cUmRuI2beQPa5GSONF7uDmDAv0zZYbObima4EPqMkPM/vUVwD/kJBXwCGdMTwv1RcZjJ7gC6Mwz7jh7OZ2ybK5pWbMUlYvCS2lrWyEkDpVqXtIaxPfbhmUEtQA2U8Aa6rnfCcVbA52ohlvPWqYlm4f9QxHT4PeGC6g7grfq9G9MN8i8a+DcfOtnWFNoCNIxUCRWgUeNCcZkBon2QO5lfR8ssSVxQ9doalHlhkkR7m2tub2zCYxrwrCW/anvJ4JY0+7wfkokRVcHg4=
28-
distributions: sdist bdist_wheel
28+
secure: LHsL91XR32/M4r5ETAvaN/vUTakYByIfdwdCw6EI59LBvSnwaSant010QIl39+uafuev57yzUC/Y+orefczjkJnG3KdQBNS0Rt/zWIMw0Dr6Fp41Vg66e5URK/FRIwK36WlWzOcd3GkrQLLaDeqnXVzDWVMuXPP9/1ssu6mvriSeLctPsmX5N6m4yZwxNtpFsTLEh+BumXiamCuqjTI0RpyqxYlUVfio0G5LWeY9rkPskrwbSbc8xhq/PMk/ecLtlAxdn8AwgjLYCAt9d6NRfgL4Yp0R+kkfUQsX1Wf8A/pBNRr8Ht8Hy4CNlnEphgao4fgVEY4dc6tZL3FXOU9jQSmbChoANlbPzDhO+nb6d/QW5vLHVDufKyRQqtFxD90XFXlWFc/0gnD6tPZhi+UEFmBMoo9ugWDnYUeBd1T3lbwKT7sOmOQS58WhDVMLxPwr2BfgItGrNsaVHmzx9v0BnxZvD5ilmvNPrad6Rcsa0N8GtNXpnbyaupWzA97bemzuLqNHOjTm6TMZWRol6lLEJsJ1MRs7xWI4DYztXzlWITH7rvf6NNyvXKe9FPV3Lfoei3k1mT8QuEh6bIEFpBKRVV0ObQVSfFQ4M4wbgDBb3CbHVqMqFHgi98mpUo9tNGm4uzZCXw3hfEQpUPugKaH+VHoaylE+MR+fOhsyVlLQluM=
29+
on:
30+
distributions: sdist bdist_wheel

CHANGELOG.rst

Lines changed: 0 additions & 58 deletions
This file was deleted.

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
include README.rst axe_selenium_python/src/axe.min.js
1+
include README.rst axe_selenium_python/node_modules/axe-core/axe.min.js axe_selenium_python/tests/test_page.html
22
recursive-include *.rst *.txt

README.rst

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ axe-selenium-python
33

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

6-
**This version of axe-selenium-python is using axe-core@3.0.3.**
6+
**This version of axe-selenium-python is using axe-core@3.1.1.**
77

88
.. image:: https://img.shields.io/badge/license-MPL%202.0-blue.svg?style=flat-square
99
:target: https://github.com/mozilla-services/axe-selenium-python/blob/master/LICENSE.txt
@@ -92,3 +92,68 @@ Resources
9292
- `Issue Tracker <http://github.com/mozilla-services/axe-selenium-python/issues>`_
9393
- `Code <http://github.com/mozilla-services/axe-selenium-python/>`_
9494
- `pytest-axe <http://github.com/mozilla-services/pytest-axe/>`_
95+
96+
CHANGELOG
97+
^^^^^^^^^^^^^^
98+
99+
version 2.1.0
100+
**************
101+
- Created package.json file to maintain axe-core dependency
102+
- Replaced unit tests with more meaningful integration tests
103+
- included a sample html file for integration tests
104+
105+
version 2.0.0
106+
**************
107+
- All functionalities that are not part of axe-core have been moved into a separate package, ``pytest-axe``. This includes:
108+
- ``run_axe`` helper method
109+
- ``get_rules`` Axe class method
110+
- ``run`` Axe class method
111+
- ``impact_included`` Axe class method
112+
- ``analyze`` Axe class method.
113+
114+
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.
115+
116+
All functionalities can still be utilized when using ``axe-selenium-python`` in conjunction with ``pytest-axe``.
117+
118+
version 1.2.3
119+
**************
120+
- 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.
121+
- 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.
122+
- Accessibility checks can be disabled by setting the environment variable ``ACCESSIBILITY_DISABLED=true``.
123+
124+
version 1.2.1
125+
**************
126+
- Updated axe.min.js to ``axe-core@2.6.1``
127+
- Modified impact_included class method to reflect changes to the aXe API:
128+
- There are now only 3 impact levels: 'critical', 'serious', and 'minor'
129+
130+
version 1.0.0
131+
**************
132+
- Updated usage examples in README
133+
- Added docstrings to methods lacking documentation
134+
- Removed unused files
135+
136+
version 0.0.3
137+
**************
138+
- Added run method to Axe class to simplify the usage in existing test suites
139+
- run method includes the ability to set what impact level to test for: 'minor', 'moderate', 'severe', 'critical'
140+
141+
version 0.0.276
142+
****************
143+
- Added pytest-axe usage example to README
144+
145+
version 0.0.275
146+
****************
147+
- Added usage example to README
148+
149+
version 0.0.273
150+
****************
151+
- Added selenium instance as a class attribute
152+
- Changed file paths to OS independent structure
153+
- Fixed file read operations to use with keyword
154+
155+
156+
version 0.0.21
157+
***************
158+
- Fixed include of aXe API file and references to it
159+
- Updated README

axe_selenium_python/axe.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from io import open
77
from os import path
88

9-
_DEFAULT_SCRIPT = path.join(path.dirname(__file__), 'src', 'axe.min.js')
9+
_DEFAULT_SCRIPT = path.join(path.dirname(__file__), 'node_modules', 'axe-core', 'axe.min.js')
1010

1111

1212
class Axe(object):

axe_selenium_python/package-lock.json

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

axe_selenium_python/package.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"name": "axe-selenium-python",
3+
"version": "0.0.1",
4+
"description": "Integrate axe-core with python",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "git+https://github.com/kimberlythegeek/axe-selenium-python.git"
12+
},
13+
"author": "Kimberly Sereduck",
14+
"license": "MPL-2.0",
15+
"bugs": {
16+
"url": "https://github.com/kimberlythegeek/axe-selenium-python/issues"
17+
},
18+
"homepage": "https://github.com/kimberlythegeek/axe-selenium-python#readme",
19+
"dependencies": {
20+
"axe-core": ">=3.1.0"
21+
}
22+
}

axe_selenium_python/src/axe.min.js

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
pytest==3.7.2
1+
pytest==3.7.3
22
selenium==3.14.0
33
pytest-html==1.19.0

0 commit comments

Comments
 (0)