Metadata-Version: 1.0
Name: axe-selenium-python
Version: 0.0.3
Summary: Python library to integrate axe and selenium for web                 accessibility testing.
Home-page: http://github.com/kimberlythegeek/axe-selenium-python
Author: Kimberly Pennington
Author-email: kpennington@mozilla.com
License: Mozilla Public License 2.0 (MPL 2.0)
Description: axe-selenium-python
        ====================
        
        axe-selenium-python integrates aXe and selenium to enable automated web accessibility testing.
        
        .. image:: https://img.shields.io/badge/license-MPL%202.0-blue.svg?style=plastic
           :target: https://github.com/kimberlythegeek/axe-selenium-python/blob/master/LICENSE.txt
           :alt: License
        .. image:: https://img.shields.io/pypi/v/axe-selenium-python.svg?style=plastic
           :target: https://pypi.org/project/axe-selenium-python/
           :alt: PyPI
        .. image:: https://img.shields.io/pypi/wheel/axe-selenium-python.svg?style=plastic
           :target: https://pypi.org/project/axe-selenium-python/
           :alt: wheel
        .. image:: https://img.shields.io/travis/kimberlythegeek/axe-selenium-python.svg?style=plastic
           :target: https://travis-ci.org/kimberlythegeek/axe-selenium-python/
           :alt: Travis
        .. image:: https://img.shields.io/github/issues-raw/kimberlythegeek/axe-selenium-python.svg?style=plastic
           :target: https://github.com/kimberlythegeek/axe-selenium-python/issues
           :alt: Issues
        
        
        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
        
        Installation
        ------------
        
        To install axe-selenium-python:
        
        .. code-block:: bash
        
          $ pip install axe-selenium-python
        
        To install pytest-axe:
        
        .. code-block:: bash
        
          $ pip install pytest-axe
        
        Usage
        -----
        To run tests using pytest-selenium (a dependency of axe-selenium-python), tests must be marked with the non-destructive pytest decorator:
        
        .. code-block:: python
        
         @pytest.mark.nondestructive
         def test_my_test_function():
           assert true
        
        Test suites using axe-selenium-python must import pytest and the Axe class.
        
        
        pytest-selenium relies on the `base_url <https://github.com/pytest-dev/pytest-base-url>`_ fixture, which can be set in a configuration file, or as a command line argument.
        
        Configuration File
        ******************
        
        .. code-block:: ini
        
         [pytest]
          base_url = http://www.example.com
        
        Command Line Argument
        *********************
        
        .. code-block:: bash
        
          $ pytest --base-url http://www.example.com
        
        Example Test Function
        **********************
        
        *test_accessibility.py*
        
        .. code-block:: python
        
          import pytest
          from axe_selenium_python import Axe
          import pytest_axe
        
          @pytest.mark.nondestructive
          def test_accessibility(self, axe):
        
            response = axe.execute()
        
            assert len(response['violations']) == 0, axe.report()
        
        Tests not using the axe pytest fixture must use the selenium pytest fixture:
        
        *test_accessibility.py*
        
        .. code-block:: python
        
          import pytest
          from axe_selenium_python import Axe
        
          @pytest.mark.nondestructive
          def test_accessibility(self, selenium):
        
            axe = Axe(selenium)
            response = axe.execute()
        
            assert len(response['violations']) == 0, axe.report()
        
        
        Resources
        ---------
        
        - `Issue Tracker <http://github.com/kimberlythegeek/axe-selenium-python/issues>`_
        - `Code <http://github.com/kimberlythegeek/axe-selenium-python/>`_
        - `pytest-axe <http://github.com/kimberlythegeek/pytest-axe/>`_
        
        
        CHANGELOG
        ---------
        
        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
        
Keywords: axe-core selenium pytest-selenium accessibility automation mozilla
Platform: UNKNOWN
