# percy-selenium-python
[Percy](https://percy.io) visual testing for Python Selenium.
## Installation
npm install `@percy/cli`:
```sh-session
$ npm install --save-dev @percy/cli
```
pip install Percy selenium package:
```ssh-session
$ pip install percy-selenium
```
## Usage
This is an example test using the `percy_snapshot` function.
``` python
from percy import percy_snapshot
browser = webdriver.Firefox()
browser.get('http://example.com')
# take a snapshot
percy_snapshot(browser, 'Python example')
```
Running the test above normally will result in the following log:
```sh-session
[percy] Percy is not running, disabling snapshots
```
When running with [`percy
exec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's
`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.
```sh-session
$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- [python test command]
[percy] Percy has started!
[percy] Created build #1: https://percy.io/[your-project]
[percy] Snapshot taken "Python example"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!
```
## Configuration
`percy_snapshot(driver, name[, **kwargs])`
- `driver` (**required**) - A selenium-webdriver driver instance
- `name` (**required**) - The snapshot name; must be unique to each snapshot
- `**kwargs` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)
### Migrating Config
If you have a previous Percy configuration file, migrate it to the newest version with the
[`config:migrate`](https://github.com/percy/cli/tree/master/packages/cli-config#percy-configmigrate-filepath-output) command:
```sh-session
$ percy config:migrate
```
## Percy on Automate
## Usage
This is an example test using the `percy_screenshot` function.
`percy_screenshot(driver, name, options)` [ needs @percy/cli 1.27.0-beta.0+ ];
``` python
from percy import percy_screenshot
driver = webdriver.Remote("https://hub-cloud.browserstack.com/wd/hub", caps) # using automate session
driver.get('http://example.com')
# take a snapshot
percy_screenshot(driver, name = 'Screenshot 1')
```
- `driver` (**required**) - A Selenium driver instance
- `name` (**required**) - The screenshot name; must be unique to each screenshot
- `options` (**optional**) - There are various options supported by percy_screenshot to server further functionality.
- `sync` - Boolean value by default it falls back to `false`, Gives the processed result around screenshot [From CLI v1.28.0-beta.0+]
- `full_page` - Boolean value by default it falls back to `false`, Takes full page screenshot [From CLI v1.27.6+]
- `freeze_animated_image` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.
- `freeze_image_by_selectors` -List of selectors. Images will be freezed which are passed using selectors. For this to work `freeze_animated_image` must be set to true.
- `freeze_image_by_xpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freeze_animated_image` must be set to true.
- `percy_css` - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.
- `ignore_region_xpaths` - List of xpaths. elements in the DOM can be ignored using xpath
- `ignore_region_selectors` - List of selectors. elements in the DOM can be ignored using selectors.
- `ignore_region_selenium_elements` - List of selenium web-element. elements can be ignored using selenium_elements.
- `custom_ignore_regions` - List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below.
- example: ```{"top": 10, "right": 10, "bottom": 120, "left": 10}```
- In above example it will draw rectangle of ignore region as per given coordinates.
- `top` (int): Top coordinate of the ignore region.
- `bottom` (int): Bottom coordinate of the ignore region.
- `left` (int): Left coordinate of the ignore region.
- `right` (int): Right coordinate of the ignore region.
- `consider_region_xpaths` - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths.
- `consider_region_selectors` - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors.
- `consider_region_selenium_elements` - List of selenium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using selenium_elements.
- `custom_consider_regions` - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries
- example:```{"top": 10, "right": 10, "bottom": 120, "left": 10}```
- In above example it will draw rectangle of consider region will be drawn.
- Parameters:
- `top` (int): Top coordinate of the consider region.
- `bottom` (int): Bottom coordinate of the consider region.
- `left` (int): Left coordinate of the consider region.
- `right` (int): Right coordinate of the consider region.
### Creating Percy on automate build
Note: Automate Percy Token starts with `auto` keyword. The command can be triggered using `exec` keyword.
```sh-session
$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- [python test command]
[percy] Percy has started!
[percy] [Python example] : Starting automate screenshot ...
[percy] Screenshot taken "Python example"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!
```
Refer to docs here: [Percy on Automate](https://www.browserstack.com/docs/percy/integrate/functional-and-visual)
Raw data
{
"_id": null,
"home_page": "https://github.com/percy/percy-selenium-python",
"name": "percy-selenium",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "selenium percy visual testing",
"author": "Perceptual Inc.",
"author_email": "team@percy.io",
"download_url": "https://files.pythonhosted.org/packages/86/50/1d3913454e21be771371784cf3d35389b72322a5e7909b3aab2eaa2dcd1c/percy_selenium-2.1.1.tar.gz",
"platform": null,
"description": "# percy-selenium-python\n\n\n[Percy](https://percy.io) visual testing for Python Selenium.\n\n## Installation\n\nnpm install `@percy/cli`:\n\n```sh-session\n$ npm install --save-dev @percy/cli\n```\n\npip install Percy selenium package:\n\n```ssh-session\n$ pip install percy-selenium\n```\n\n## Usage\n\nThis is an example test using the `percy_snapshot` function.\n\n``` python\nfrom percy import percy_snapshot\n\nbrowser = webdriver.Firefox()\nbrowser.get('http://example.com')\n\u200b\n# take a snapshot\npercy_snapshot(browser, 'Python example')\n```\n\nRunning the test above normally will result in the following log:\n\n```sh-session\n[percy] Percy is not running, disabling snapshots\n```\n\nWhen running with [`percy\nexec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's\n`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.\n\n```sh-session\n$ export PERCY_TOKEN=[your-project-token]\n$ percy exec -- [python test command]\n[percy] Percy has started!\n[percy] Created build #1: https://percy.io/[your-project]\n[percy] Snapshot taken \"Python example\"\n[percy] Stopping percy...\n[percy] Finalized build #1: https://percy.io/[your-project]\n[percy] Done!\n```\n\n## Configuration\n\n`percy_snapshot(driver, name[, **kwargs])`\n\n- `driver` (**required**) - A selenium-webdriver driver instance\n- `name` (**required**) - The snapshot name; must be unique to each snapshot\n- `**kwargs` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)\n\n### Migrating Config\n\nIf you have a previous Percy configuration file, migrate it to the newest version with the\n[`config:migrate`](https://github.com/percy/cli/tree/master/packages/cli-config#percy-configmigrate-filepath-output) command:\n\n```sh-session\n$ percy config:migrate\n```\n\n## Percy on Automate\n\n## Usage\n\nThis is an example test using the `percy_screenshot` function.\n`percy_screenshot(driver, name, options)` [ needs @percy/cli 1.27.0-beta.0+ ];\n\n``` python\nfrom percy import percy_screenshot\n\ndriver = webdriver.Remote(\"https://hub-cloud.browserstack.com/wd/hub\", caps) # using automate session\ndriver.get('http://example.com')\n\u200b\n# take a snapshot\npercy_screenshot(driver, name = 'Screenshot 1')\n```\n\n- `driver` (**required**) - A Selenium driver instance\n- `name` (**required**) - The screenshot name; must be unique to each screenshot\n- `options` (**optional**) - There are various options supported by percy_screenshot to server further functionality.\n - `sync` - Boolean value by default it falls back to `false`, Gives the processed result around screenshot [From CLI v1.28.0-beta.0+]\n - `full_page` - Boolean value by default it falls back to `false`, Takes full page screenshot [From CLI v1.27.6+]\n - `freeze_animated_image` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.\n - `freeze_image_by_selectors` -List of selectors. Images will be freezed which are passed using selectors. For this to work `freeze_animated_image` must be set to true.\n - `freeze_image_by_xpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freeze_animated_image` must be set to true.\n - `percy_css` - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.\n - `ignore_region_xpaths` - List of xpaths. elements in the DOM can be ignored using xpath\n - `ignore_region_selectors` - List of selectors. elements in the DOM can be ignored using selectors.\n - `ignore_region_selenium_elements` - List of selenium web-element. elements can be ignored using selenium_elements.\n - `custom_ignore_regions` - List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below.\n - example: ```{\"top\": 10, \"right\": 10, \"bottom\": 120, \"left\": 10}```\n - In above example it will draw rectangle of ignore region as per given coordinates.\n - `top` (int): Top coordinate of the ignore region.\n - `bottom` (int): Bottom coordinate of the ignore region.\n - `left` (int): Left coordinate of the ignore region.\n - `right` (int): Right coordinate of the ignore region.\n - `consider_region_xpaths` - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths.\n - `consider_region_selectors` - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors.\n - `consider_region_selenium_elements` - List of selenium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using selenium_elements.\n - `custom_consider_regions` - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries\n - example:```{\"top\": 10, \"right\": 10, \"bottom\": 120, \"left\": 10}```\n - In above example it will draw rectangle of consider region will be drawn.\n - Parameters:\n - `top` (int): Top coordinate of the consider region.\n - `bottom` (int): Bottom coordinate of the consider region.\n - `left` (int): Left coordinate of the consider region.\n - `right` (int): Right coordinate of the consider region.\n\n\n### Creating Percy on automate build\nNote: Automate Percy Token starts with `auto` keyword. The command can be triggered using `exec` keyword.\n\n```sh-session\n$ export PERCY_TOKEN=[your-project-token]\n$ percy exec -- [python test command]\n[percy] Percy has started!\n[percy] [Python example] : Starting automate screenshot ...\n[percy] Screenshot taken \"Python example\"\n[percy] Stopping percy...\n[percy] Finalized build #1: https://percy.io/[your-project]\n[percy] Done!\n```\n\nRefer to docs here: [Percy on Automate](https://www.browserstack.com/docs/percy/integrate/functional-and-visual)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for visual testing with Percy",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://github.com/percy/percy-selenium-python"
},
"split_keywords": [
"selenium",
"percy",
"visual",
"testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4fa514f20ff8cdf2f2cea29b505c7cdabea26386a0962930802914e432e7432d",
"md5": "ead4a2f9253f3412815879c22a28fdec",
"sha256": "c47435c3fe95ac08bcc047bb2fd75d3a3262bd15f278ef6d5b20ba03851b6811"
},
"downloads": -1,
"filename": "percy_selenium-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ead4a2f9253f3412815879c22a28fdec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9130,
"upload_time": "2024-10-18T11:11:44",
"upload_time_iso_8601": "2024-10-18T11:11:44.081903Z",
"url": "https://files.pythonhosted.org/packages/4f/a5/14f20ff8cdf2f2cea29b505c7cdabea26386a0962930802914e432e7432d/percy_selenium-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86501d3913454e21be771371784cf3d35389b72322a5e7909b3aab2eaa2dcd1c",
"md5": "bebd74175f6c3048cea2c86cde4c757f",
"sha256": "6db18bb8933812e4fd27ba952711f8f5470ab51d125422c2b6ebc7256f9891e4"
},
"downloads": -1,
"filename": "percy_selenium-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "bebd74175f6c3048cea2c86cde4c757f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 14657,
"upload_time": "2024-10-18T11:11:45",
"upload_time_iso_8601": "2024-10-18T11:11:45.701213Z",
"url": "https://files.pythonhosted.org/packages/86/50/1d3913454e21be771371784cf3d35389b72322a5e7909b3aab2eaa2dcd1c/percy_selenium-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 11:11:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "percy",
"github_project": "percy-selenium-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "percy-selenium"
}
JSON
