Skip to content

Commit f4f81d7

Browse files
mdmintzmdmintz
committed
Update the docs
1 parent aa690d9 commit f4f81d7

File tree

4 files changed

+23
-37
lines changed

4 files changed

+23
-37
lines changed

‎README.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,19 @@
66
<link rel="icon" href="https://seleniumbase.io/img/logo3a.png" />
77

88
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
9-
<img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" alt="SeleniumBase" title="SeleniumBase" width="300" />
9+
<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="300" />
1010
</a></p>
11-
<p align="center"><b>The complete web automation library.</b></p>
12-
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
13-
<img src="https://seleniumbase.io/img/sb_logo_10.png" alt="SeleniumBase" width="152" /></a><a href="https://github.com/seleniumbase/SeleniumBase/">
14-
<img src="https://seleniumbase.io/cdn/img/sb_demo_site.png" alt="SeleniumBase" width="152" />
15-
</a></p>
16-
<p align="center">Powered by WebDriver APIs and pytest.</p>
11+
1712
<!-- View on GitHub -->
18-
<p align="center">
19-
<a href="https://github.com/seleniumbase/SeleniumBase/releases">
13+
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/releases">
2014
<img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=2277EE" alt="Latest Release on GitHub" /></a> <a href="https://pypi.python.org/pypi/seleniumbase">
21-
<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=22AAEE" alt="Latest Release on PyPI" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions">
22-
<img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase">
15+
<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=22AAEE" alt="Latest Release on PyPI" /></a> <a href="https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master"> <img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt="SeleniumBase Azure Pipelines" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions">
16+
<img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/stargazers"> <img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=9A77EC" alt="SeleniumBase GitHub Stars" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase">
2317
<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a> <a href="https://seleniumbase.io">
24-
<img src="https://img.shields.io/badge/docs-%20seleniumbase.io-22BBAA.svg" alt="SeleniumBase.io Docs" /></a>
25-
</p>
18+
<img src="https://img.shields.io/badge/docs-%20seleniumbase.io-22BBAA.svg" alt="SeleniumBase.io Docs" /></a></p>
2619

27-
<p>
28-
<b>SeleniumBase</b> is an all-in-one framework for reliable browser automation, end-to-end testing, reports, charts, presentations, website tours, and visual testing.
29-
Tests are run with <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>. Browsers are controlled by <a href="https://www.w3.org/TR/webdriver2/#endpoints">WebDriver</a>.
30-
</p>
20+
<p><b>SeleniumBase</b> is a complete framework for browser automation, end-to-end testing, reports, charts, presentations, website tours, and visual testing.
21+
Tests are run with <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>. Browsers are controlled by <a href="https://www.w3.org/TR/webdriver2/#endpoints">WebDriver</a>.</p>
3122

3223
<p align="center">
3324
<a href="#python_installation">🚀 Start</a> |
@@ -58,23 +49,21 @@ Tests are run with <a href="https://docs.pytest.org/en/latest/index.html">pytest
5849
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🛂 MasterQA</a>
5950
</p>
6051

52+
* Uses reliable, smart-waiting code to prevent flaky tests.
53+
* Simplifies the process of creating UI tests for any website.
54+
* Includes [Plugins](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) for logging [test results and screenshots](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
55+
* Has versatile [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) and [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
56+
6157
--------
6258

63-
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py"><img src="https://seleniumbase.io/cdn/gif/swag_mobile_2.gif" alt="SeleniumBase Mobile Mode" title="SeleniumBase Mobile Mode" /></a></p>
59+
<p align="center">(Below: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py">test_swag_labs.py</a> using Demo Mode.)</p>
6460

6561
```bash
66-
pytest test_swag_labs.py --mobile
62+
pytest test_swag_labs.py --demo
6763
```
6864

69-
<p align="center">(Above: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py">test_swag_labs.py</a> in Mobile Mode.)</p>
70-
71-
<div><p align="center">(Below: Same test running in Demo Mode.)</p></div>
7265
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py"><img src="https://seleniumbase.io/cdn/gif/swag_demo_2.gif" alt="SeleniumBase Demo Mode" title="SeleniumBase Demo Mode" /></a></p>
7366

74-
```bash
75-
pytest test_swag_labs.py --demo
76-
```
77-
7867
--------
7968

8069
<a id="python_installation"></a>
@@ -326,7 +315,7 @@ For a full list of SeleniumBase features, <a href="https://github.com/seleniumba
326315
327316
328317
<a id="detailed_instructions"></a>
329-
<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">
318+
<img src="https://seleniumbase.io/img/sb_logo_10.png" title="SeleniumBase" width="290">
330319
331320
<h2><img src="https://seleniumbase.io/img/logo3a.png" title="SeleniumBase" width="32" /> Detailed Instructions:</h2>
332321
@@ -398,7 +387,7 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
398387
--proxy=USERNAME:PASSWORD@SERVER:PORT # (Use authenticated proxy server.)
399388
--agent=STRING # (Modify the web browser's User-Agent string.)
400389
--mobile # (Use the mobile device emulator while running tests.)
401-
--metrics=STRING # (Set mobile "CSSWidth,CSSHeight,PixelRatio".)
390+
--metrics=STRING # (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
402391
--extension-zip=ZIP # (Load a Chrome Extension .zip|.crx, comma-separated.)
403392
--extension-dir=DIR # (Load a Chrome Extension directory, comma-separated.)
404393
--headless # (Run tests headlessly. Default mode on Linux OS.)
@@ -893,7 +882,7 @@ Additionally, you can use the ``@retry_on_exception()`` decorator to specificall
893882
</p>
894883
<p><div><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></div></p>
895884
896-
<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290" /></a></div>
885+
<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="290" /></a></div>
897886
898887
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases"><img src="https://img.shields.io/github/repo-size/seleniumbase/seleniumbase.svg" title="SeleniumBase" alt="Repo Size" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" title="SeleniumBase" alt="Join the chat!" /></a></div>
899888

‎help_docs/customizing_test_runs.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,16 @@ Here are some examples of configuring tests, which can be run from the [examples
88

99
```bash
1010
# Run a test in Chrome (default browser)
11-
pytest test_swag_labs.py
11+
pytest my_first_test.py
1212

1313
# Run a test in Firefox
1414
pytest test_swag_labs.py --browser=firefox
1515

1616
# Run a test in Demo Mode (highlight assertions)
17-
pytest my_first_test.py --demo
18-
19-
# Run another test in Demo Mode
2017
pytest test_demo_site.py --demo
2118

2219
# Run a test in Headless Mode (invisible browser)
23-
pytest my_first_test.py --headless
20+
pytest test_demo_site.py --headless
2421

2522
# Run tests multi-threaded using [n] threads
2623
pytest test_suite.py -n=4
@@ -108,7 +105,7 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
108105
--proxy=SERVER:PORT # (Connect to a proxy server:port for tests.)
109106
--proxy=USERNAME:PASSWORD@SERVER:PORT # (Use authenticated proxy server.)
110107
--mobile # (Use the mobile device emulator while running tests.)
111-
--metrics=STRING # (Set mobile "CSSWidth,CSSHeight,PixelRatio".)
108+
--metrics=STRING # (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
112109
--extension-zip=ZIP # (Load a Chrome Extension .zip|.crx, comma-separated.)
113110
--extension-dir=DIR # (Load a Chrome Extension directory, comma-separated.)
114111
--headless # (Run tests headlessly. Default mode on Linux OS.)

‎seleniumbase/plugins/pytest_plugin.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def pytest_addoption(parser):
2929
--proxy=USERNAME:PASSWORD@SERVER:PORT (Use authenticated proxy server.)
3030
--agent=STRING (Modify the web browser's User-Agent string.)
3131
--mobile (Use the mobile device emulator while running tests.)
32-
--metrics=STRING (Set mobile "CSSWidth,CSSHeight,PixelRatio".)
32+
--metrics=STRING (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
3333
--extension-zip=ZIP (Load a Chrome Extension .zip|.crx, comma-separated.)
3434
--extension-dir=DIR (Load a Chrome Extension directory, comma-separated.)
3535
--headless (Run tests headlessly. Default mode on Linux OS.)

‎seleniumbase/plugins/selenium_plugin.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class SeleniumBrowser(Plugin):
2020
--proxy=USERNAME:PASSWORD@SERVER:PORT (Use authenticated proxy server.)
2121
--agent=STRING (Modify the web browser's User-Agent string.)
2222
--mobile (Use the mobile device emulator while running tests.)
23-
--metrics=STRING (Set mobile "CSSWidth,CSSHeight,PixelRatio".)
23+
--metrics=STRING (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
2424
--extension-zip=ZIP (Load a Chrome Extension .zip|.crx, comma-separated.)
2525
--extension-dir=DIR (Load a Chrome Extension directory, comma-separated.)
2626
--headless (Run tests headlessly. Default mode on Linux OS.)

0 commit comments

Comments
 (0)