Update the docs
This commit is contained in:
Michael Mintz
parent
dfffd66e3f
commit
4b00eb1dc0
14
README.md
14
README.md
|
|
@ -1,15 +1,15 @@
|
|||
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb12.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
|
||||
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_dg.png" title="SeleniumBase" align="center" height="155">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
|
||||
|
||||
[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt=" " />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)
|
||||
|
||||
All-in-one framework for web automation, end-to-end testing, and website tours. SeleniumBase uses [pytest](https://pytest.org) for running Python scripts, while using [Selenium WebDriver](https://selenium.dev/) for controlling web browsers.
|
||||
|
||||
* Helps you quickly build reliable tests for any website.
|
||||
* Uses easy-to-learn [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for writing tests.
|
||||
* Includes flexible [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) for running tests.
|
||||
* Includes tools for [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), & [web tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
|
||||
* Integrates with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md), [Katalon Recorder](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md), and more.
|
||||
* To see the full list of SeleniumBase features, [click here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md).
|
||||
* No more flaky/unreliable tests!
|
||||
* Easy-to-learn [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md).
|
||||
* Flexible [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
|
||||
* Both browser & mobile testing.
|
||||
* Includes a [website tour builder](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
|
||||
* To see more features, [click here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md).
|
||||
|
||||
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_gif.gif" title="SeleniumBase"><br />
|
||||
(<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) in Demo Mode.</i>)<br />
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_d.png" title="SeleniumBase" align="center" height="155">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
|
||||
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_dg.png" title="SeleniumBase" align="center" height="155">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
|
||||
|
||||
## Running Tests
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ Run an example test in Firefox:
|
|||
pytest my_first_test.py --browser=firefox
|
||||
```
|
||||
|
||||
Run an example test in Demo Mode: (highlight assertions)
|
||||
Run an example test in Demo Mode: (highlights assertions)
|
||||
```bash
|
||||
pytest my_first_test.py --demo
|
||||
```
|
||||
|
|
@ -30,6 +30,11 @@ Run an example test in Headless Mode: (invisible web browser)
|
|||
pytest my_first_test.py --headless
|
||||
```
|
||||
|
||||
Run tests with verbose output per test: (improves logging)
|
||||
```bash
|
||||
pytest test_suite.py -v
|
||||
```
|
||||
|
||||
Run tests multi-threaded using [n] threads:
|
||||
```bash
|
||||
pytest test_suite.py -n=4
|
||||
|
|
@ -37,7 +42,7 @@ pytest test_suite.py -n=4
|
|||
|
||||
Run a parameterized test, which generates multiple tests out of one:
|
||||
```bash
|
||||
pytest parameterized_test.py
|
||||
pytest parameterized_test.py -v
|
||||
```
|
||||
|
||||
Run an example test suite and generate a pytest report: (pytest-only)
|
||||
|
|
@ -62,12 +67,12 @@ pytest test_fail.py --pdb -s
|
|||
|
||||
Run an example test suite that demonstrates the use of pytest markers:
|
||||
```bash
|
||||
pytest -v -m marker_test_suite
|
||||
pytest -m marker_test_suite -v
|
||||
```
|
||||
|
||||
Run an example test suite that reuses the browser session between tests:
|
||||
```bash
|
||||
pytest test_suite.py --reuse-session
|
||||
pytest test_suite.py --reuse-session -v
|
||||
```
|
||||
|
||||
Run an example test demonstrating the ``rate_limited`` Python decorator:
|
||||
|
|
|
|||
|
|
@ -74,7 +74,9 @@ Here's the command-line option to add to tests: (See [examples/custom_settings.p
|
|||
``--settings-file=custom_settings.py``
|
||||
(Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, and other important settings used by tests.)
|
||||
|
||||
#### **Running tests on [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, the [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid, the [TestingBot](https://testingbot.com/features) Selenium Grid, (or your own):**
|
||||
#### **Running tests on [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, the [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid, the [TestingBot](https://testingbot.com/features) Selenium Grid, another grid, or your own:**
|
||||
|
||||
(For setting browser desired capabilities while running Selenium remotely, see the ReadMe located here: https://github.com/seleniumbase/SeleniumBase/tree/master/examples/capabilities)
|
||||
|
||||
Here's how to connect to a BrowserStack Selenium Grid server for running tests:
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb9.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
|
||||
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb14.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
|
||||
|
||||
<a id="feature_list"></a>
|
||||
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> **Features:**
|
||||
|
|
|
|||
Loading…
Reference in New Issue