Skip to content

Commit 87f7d97

Browse files
Rewrote README
1 parent 4cb0866 commit 87f7d97

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

README.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,44 @@
1-
# Applitools Tutorial - Selenium Python Ultrafast Grid
1+
# Applitools Tutorial: Selenium Python pytest with the Ultrafast Grid
22

3-
Get started with Applitools Eyes visual testing with this example of using Selenium Python and the [Eyes Selenium Python SDK](https://applitools.com/docs/api/eyes-sdk/index-gen/classindex-selenium-python_sdk4.html).
3+
This is the example project for the [Selenium Python pytest tutorial](https://applitools.com/tutorials/quickstart/web/selenium/python).
4+
It shows how to start automating visual tests
5+
with [Applitools Eyes](https://applitools.com/platform/eyes/)
6+
and the [Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/)
7+
using [Selenium](https://www.selenium.dev/) in Python.
48

5-
Learn more about how to install and start this project with our [Selenium Python tutorial](https://applitools.com/tutorials/selenium-python.html)!
9+
It uses:
610

7-
<https://applitools.com/tutorials/selenium-python.html>
11+
* [Python](https://www.python.org/) as the programming language
12+
* [Selenium WebDriver](https://www.selenium.dev/) for browser automation
13+
* [pytest](https://docs.pytest.org/) as the core test framework
14+
* [Google Chrome](https://www.google.com/chrome/downloads/) as the local browser for testing
15+
* [pip](https://packaging.python.org/en/latest/tutorials/installing-packages/) for dependency management
16+
* [Applitools Eyes](https://applitools.com/platform/eyes/) for visual testing
17+
* [Applitools Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/) for cross-browser execution
818

9-
## More Information
19+
To run this example project, you'll need:
1020

11-
Learn more about Applitools [Eyes](https://info.applitools.com/ucY77) and the [Ultrafast Test Cloud](https://info.applitools.com/ucY78) at [applitools.com](https://info.applitools.com/ucY76).
21+
1. An [Applitools account](https://auth.applitools.com/users/register), which you can register for free
22+
2. A recent version of [Python 3](https://www.python.org/)
23+
3. A good Python editor like [Visual Studio Code](https://code.visualstudio.com/docs/languages/python)
24+
or [PyCharm](https://www.jetbrains.com/pycharm/).
25+
4. An up-to-date version of [Google Chrome](https://www.google.com/chrome/downloads/).
1226

13-
More about the Eyes Images SDK:
14-
* https://applitools.com/docs/api/eyes-sdk/index-gen/classindex-selenium-python_sdk4.html
27+
To install dependencies, run:
28+
29+
```
30+
pip install -r requirements.txt
31+
```
32+
33+
The main test case spec is [`test_acme_bank.py`](tests/test_acme_bank.py).
34+
35+
To execute tests, set the `APPLITOOLS_API_KEY` environment variable
36+
to your [account's API key](https://applitools.com/tutorials/getting-started/setting-up-your-environment.html),
37+
and then run:
38+
39+
```
40+
python3 -m pytest tests
41+
```
42+
43+
**For full instructions on running this project, take our
44+
[Selenium Python pytest tutorial](https://applitools.com/tutorials/quickstart/web/selenium/python)!**

0 commit comments

Comments
 (0)