# axe-playwright-python
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-playwright-python/).
## Dependencies
- 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-playwright-python/).
## Contributing
See [guide on contributing](CONTRIBUTING.md).
## Acknowledgments
This project is based on [axe-core-python](https://github.com/ruslan-rv-ua/axe-core-python) by @ruslan-rv-ua and also takes inspiration from [axe-selenium-python](https://pypi.org/project/axe-selenium-python/) for output formats.
Raw data
{
"_id": null,
"home_page": null,
"name": "axe-playwright-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "accessibility,axe,axe-core,playwright",
"author": null,
"author_email": "Pamela Fox <pamela.fox@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6c/e6/1b5f21cb55fa7fcba64a1efe9989208650f87b3e23ff23d79dadfb83b41f/axe_playwright_python-0.1.4.tar.gz",
"platform": null,
"description": "# axe-playwright-python\n\nAutomated web accessibility testing using [axe-core](https://github.com/dequelabs/axe-core) engine\nand [Playwright](https://playwright.dev/python/docs/intro).\n\n## Documentation\n\n- [Full documentation](https://pamelafox.github.io/axe-playwright-python/).\n\n## Dependencies\n\n- Python >= 3.10\n- [playwright](https://github.com/microsoft/playwright-python) >= 1.25.0\n\n## Installation\n\n```console\npython3 -m pip install -U axe-playwright-python\npython3 -m playwright install --with-deps\n```\n\n## Usage\n\n```python\nfrom playwright.sync_api import sync_playwright\nfrom axe_core_python.sync_playwright import Axe\n\naxe = Axe()\n\nwith sync_playwright() as playwright:\n browser = playwright.chromium.launch()\n page = browser.new_page()\n page.goto(\"https://www.google.com\")\n results = axe.run(page)\n browser.close()\n\nprint(f\"Found {results.violations_count} violations.\")\nprint(f\"Full axe-core response: {results.response}\")\n```\n\nFor more examples see [documentation](https://pamelafox.github.io/axe-playwright-python/).\n\n## Contributing\n\nSee [guide on contributing](CONTRIBUTING.md).\n\n## Acknowledgments\n\nThis project is based on [axe-core-python](https://github.com/ruslan-rv-ua/axe-core-python) by @ruslan-rv-ua and also takes inspiration from [axe-selenium-python](https://pypi.org/project/axe-selenium-python/) for output formats.\n",
"bugtrack_url": null,
"license": null,
"summary": "Automated web accessibility testing using axe-core engine and Playwright.",
"version": "0.1.4",
"project_urls": {
"Documentation": "https://pamelafox.github.io/axe-playwright-python",
"GitHub": "https://github.com/pamelafox/pytest-axe-playwright-snapshot"
},
"split_keywords": [
"accessibility",
"axe",
"axe-core",
"playwright"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ce1b3fdbaba9260311a0bbb1d387242032da4fe2b83b14670d487d141caded7a",
"md5": "47bf0a5f949bdec929ad17602ae1150d",
"sha256": "74c0993ac92c2ede522c56bf2cdda42216b22af53c4d94a684767fd42883c7fb"
},
"downloads": -1,
"filename": "axe_playwright_python-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47bf0a5f949bdec929ad17602ae1150d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 116731,
"upload_time": "2023-07-25T13:15:17",
"upload_time_iso_8601": "2023-07-25T13:15:17.420069Z",
"url": "https://files.pythonhosted.org/packages/ce/1b/3fdbaba9260311a0bbb1d387242032da4fe2b83b14670d487d141caded7a/axe_playwright_python-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6ce61b5f21cb55fa7fcba64a1efe9989208650f87b3e23ff23d79dadfb83b41f",
"md5": "a5d3d3e82e6a6fd0b57d58b0b150488d",
"sha256": "100f2f4af4525eea231bcc527ac40593805523e1433984e048fde28fea1d488a"
},
"downloads": -1,
"filename": "axe_playwright_python-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "a5d3d3e82e6a6fd0b57d58b0b150488d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 148933,
"upload_time": "2023-07-25T13:15:23",
"upload_time_iso_8601": "2023-07-25T13:15:23.249764Z",
"url": "https://files.pythonhosted.org/packages/6c/e6/1b5f21cb55fa7fcba64a1efe9989208650f87b3e23ff23d79dadfb83b41f/axe_playwright_python-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-25 13:15:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pamelafox",
"github_project": "pytest-axe-playwright-snapshot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "axe-playwright-python"
}
JSON
