Skip to content

Commit ec80cc4

Browse files
committed
Update the docs
1 parent 73e0cb8 commit ec80cc4

File tree

2 files changed

+21
-13
lines changed

2 files changed

+21
-13
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_media_logo_4.png" title="SeleniumBase" height="170">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
22

3-
[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the SeleniumBase Gitter chat" />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)<br />
3+
[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the SeleniumBase Gitter chat" />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers) [<img src="https://img.shields.io/github/repo-size/seleniumbase/seleniumbase.svg" alt="Size" />](https://github.com/seleniumbase/SeleniumBase/releases)<br />
44

5-
Automate & test more in less time with [Selenium-WebDriver](https://www.seleniumhq.org/) and [Pytest](https://docs.pytest.org/en/latest/).
5+
✅ Everything you need to automate Web/UI testing.
66

77
<img src="https://cdn2.hubspot.net/hubfs/100006/sb_demo_mode.gif" title="SeleniumBase" height="236"><br />
88
(<i>Above: [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) from [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) running in demo mode, which adds JavaScript for highlighting page actions.</i>)<br />
99
```
1010
pytest my_first_test.py --demo_mode
1111
```
1212

13+
SeleniumBase is an all-in-one test automation framework that uses WebDriver APIs for spinning up web browsers while using pytest and nosetests for running tests.
14+
1315
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Quick Start:
1416

1517
You'll need **[Python](https://www.python.org/downloads/)** [<img src="https://img.shields.io/badge/python-2.7,_3.5,_3.6,_3.7-22AADD.svg" alt="Python versions" />](https://www.python.org/downloads/)
@@ -71,13 +73,13 @@ pytest my_first_test.py --browser=chrome
7173
SeleniumBase automatically handles common WebDriver actions such as spinning up web browsers and saving screenshots during test failures. (<i>[Read more about customizing test runs](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).</i>)
7274

7375
#### **Simplified code:**<br />
74-
Instead of using messy WebDriver commands such as:
76+
SeleniumBase uses simple syntax for commands, such as:
7577
```python
76-
self.driver.find_element_by_css_selector("textarea").send_keys("text")
78+
self.update_text("textarea", "text")
7779
```
78-
...you can do the following with SeleniumBase:
80+
The same command with regular WebDriver is very messy:
7981
```python
80-
self.update_text("textarea", "text")
82+
self.driver.find_element_by_css_selector("textarea").send_keys("text")
8183
```
8284
(<i>You can still use ``self.driver`` in your code.</i>)
8385

seleniumbase/utilities/selenium_grid/ReadMe.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,25 +35,31 @@ Now you can run your tests on the Selenium Grid:
3535
pytest test_suite.py --server=IP_ADDRESS --port=4444
3636
```
3737

38-
You can also run your tests on [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid server (and not worry about managing your own Selenium Grid):
38+
You can also run your tests on someone else's Selenium Grid to avoid managing your own. Here are some Selenium Grids that you can use (and the run command format):
39+
40+
* [BrowserStack](https://www.browserstack.com/automate#) Selenium Grid:
3941

4042
```
41-
pytest my_first_test.py --server=username:key@hub.browserstack.com --port=80
43+
pytest my_first_test.py --server=USERNAME:KEY@hub.browserstack.com --port=80
4244
```
4345

44-
You can run your tests on the [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid server:
46+
* [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid:
4547

4648
```
47-
pytest my_first_test.py --server=username:key@ondemand.saucelabs.com --port=80
49+
pytest my_first_test.py --server=USERNAME:KEY@ondemand.saucelabs.com --port=80
4850
```
4951

50-
And you can run your tests on the [TestingBot](https://testingbot.com/features) Selenium Grid server:
52+
* [TestingBot](https://testingbot.com/features) Selenium Grid:
5153

5254
```
53-
pytest my_first_test.py --server=username:key@hub.testingbot.com --port=80
55+
pytest my_first_test.py --server=USERNAME:KEY@hub.testingbot.com --port=80
5456
```
5557

58+
* [CrossBrowserTesting](https://help.crossbrowsertesting.com/selenium-testing/getting-started/python/) Selenium Grid:
59+
60+
```bash
61+
pytest my_first_test.py --server=USERNAME:[email protected] --port=80
62+
```
5663

5764
#### More info about the Selenium Grid Hub can be found here:
5865
* [https://github.com/SeleniumHQ/selenium/wiki/Grid2](https://github.com/SeleniumHQ/selenium/wiki/Grid2)
59-
* [https://github.com/SeleniumHQ/selenium/wiki](https://github.com/SeleniumHQ/selenium/wiki/Grid2)

0 commit comments

Comments
 (0)