Metadata-Version: 2.1
Name: axe-playwright-python
Version: 0.1.0
Summary: Automated web accessibility testing using axe-core engine and Playwright.
Home-page: https://github.com/pamelafox/axe-playwright-python
License: MIT
Keywords: accessibility,axe,axe-core,playwright
Author: Pamela Fox
Author-email: pamela.fox@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Adaptive Technologies
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Project-URL: Documentation, https://github.com/pamelafox/axe-playwright-python
Project-URL: Repository, https://github.com/pamelafox/axe-playwright-python
Description-Content-Type: text/markdown

# axe-python-playwright

Automated web accessibility testing using [axe-core](https://github.com/dequelabs/axe-core) engine
and [Playwright](https://playwright.dev/python/docs/intro).

## Documentation

- [Full documentation](https://pamelafox.github.io/axe-python-playwright/).

## Requirements

- Python >= 3.10
- [playwright](https://github.com/microsoft/playwright-python) >= 1.25.0

## Installation

```console
python3 -m pip install -U axe-playwright-python
python3 -m playwright install --with-deps
```

## Usage

```python
from playwright.sync_api import sync_playwright
from axe_core_python.sync_playwright import Axe

axe = Axe()

with sync_playwright() as playwright:
    browser = playwright.chromium.launch()
    page = browser.new_page()
    page.goto("https://www.google.com")
    results = axe.run(page)
    browser.close()

print(f"Found {results.violations_count} violations.")
print(f"Full axe-core response: {results.response}")
```

For more examples see [documentation](https://pamelafox.github.io/axe-python-playwright/).

## Development

Install [poetry](https://python-poetry.org/).

Install the project dependencies:

```
poetry install
```

Run the tests:

```
poetry run pytest
```
