Metadata-Version: 2.1
Name: pytest-playwright-snapshot
Version: 1.0
Summary: A pytest wrapper for snapshot testing with playwright
Home-page: https://github.com/kumaraditya303/pytest-playwright-snapshot
Author: Kumar Aditya
Author-email: 
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Pytest
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: pytest-playwright (>=0.1.2)
Requires-Dist: Pillow (>=8.2.0)
Requires-Dist: pixelmatch (==0.2.3)

# Pytest Plugin for Snapshot Testing with Playwright

This plugin enables snapshot testing in playwright like snapshotting screenshots of pages, element handles etc.

## Installation

```bash
$ pip install pytest-playwright-snapshot
```

## Usage

This plugin provides a `assert_snapshot` fixture which is used to create snapshots and compare it.

Example:

```python
def test_myapp(page, assert_snapshot):
    page.goto("https://example.com")
    assert_snapshot(page.screenshot(), "example.png")
```

Ths first time you run pytest, you will get error like

```console
Failed: Snapshot not found, use --update-snapshots to create it.
```

As first you need to create golden snapshots to which this plugin will compare in future.

To create snapshots run:

```bash
$ pytest --update-snapshots
```

This will create snapshots for your tests, after that you can run the tests are usual and this will compare the snapshots.

There is `threshold` kwarg only option which can be used to set the threshold for the comparison of the screenshots and by default it is `0.1`

## License

Apache 2.0 LICENSE


