From 327d8fbc64280d3602991941e36bee1f10c27dce Mon Sep 17 00:00:00 2001
From: Michael Mintz
-
+
@@ -56,7 +56,7 @@ pytest test_swag_labs.py --demo
```
-## Get Started
+## Get Started
* Requires **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)**
* [](https://www.python.org/downloads/)
@@ -67,7 +67,7 @@ python -m pip install -U pip
```
-### Install ``seleniumbase``:
+### Install ``seleniumbase``:
```bash
git clone https://github.com/seleniumbase/SeleniumBase.git
cd SeleniumBase/
@@ -83,7 +83,7 @@ pip install seleniumbase
* Add ``--upgrade`` OR ``-U`` to upgrade an installation.
* Add ``--force-reinstall`` to also upgrade dependencies.
-### Download a webdriver:
+### Download a webdriver:
SeleniumBase can download a webdriver to the [seleniumbase/drivers](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/drivers) folder with the ``install`` command:
```bash
@@ -95,7 +95,7 @@ seleniumbase install chromedriver
seleniumbase install chromedriver latest
```
-### Run a test on Chrome:
+### Run a test on Chrome:
```bash
cd examples/
pytest my_first_test.py
@@ -154,7 +154,7 @@ self.save_screenshot(FILE_NAME) # Save a screenshot of the current page
```
For the complete list of SeleniumBase methods, see: Method Summary
-## Learn More:
+## Learn More:
#### Automatic WebDriver abilities:
SeleniumBase automatically handles common WebDriver actions such as spinning up web browsers and saving screenshots during test failures. (Read more about customizing test runs.)
@@ -203,7 +203,7 @@ For a full list of SeleniumBase features,
-## Detailed Instructions:
+## Detailed Instructions:
**Here's how to run the example script on various web browsers:**
@@ -337,7 +337,7 @@ To pass additional data from the command-line to tests, add ``--data="ANY STRING
Now inside your tests, you can use ``self.data`` to access that.
-### **Test Directory Customization:**
+### Test Directory Customization:
For running tests outside of the SeleniumBase repo with **Pytest**, you'll want a copy of **[pytest.ini](https://github.com/seleniumbase/SeleniumBase/blob/master/pytest.ini)** on the root folder. For running tests outside of the SeleniumBase repo with **Nosetests**, you'll want a copy of **[setup.cfg](https://github.com/seleniumbase/SeleniumBase/blob/master/setup.cfg)** on the root folder. (Subfolders should include a blank ``__init__.py`` file.) These files specify default configuration details for tests. (For nosetest runs, you can also specify a .cfg file by using ``--config``. Example ``nosetests [MY_TEST].py --config=[MY_CONFIG].cfg``)
@@ -349,7 +349,7 @@ pytest my_first_test.py
```
-### **Logging / Results from Failing Tests:**
+### Logging / Results from Failing Tests:
Let's try an example of a test that fails:
```python
@@ -372,7 +372,7 @@ You'll notice that a logs folder, "latest_logs", was created to hold information
-### **Creating Visual Test Suite Reports:**
+### Creating Visual Test Suite Reports:
(NOTE: Several command-line args are different for Pytest vs Nosetests)
@@ -401,7 +401,7 @@ nosetests test_suite.py --report
(NOTE: You can add ``--show-report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show-report`` when running tests locally because it pauses the test run.)
-### Using a Proxy Server:
+### Using a Proxy Server:
If you wish to use a proxy server for your browser tests (Chrome and Firefox only), you can add ``--proxy=IP_ADDRESS:PORT`` as an argument on the command-line.
```bash
@@ -419,7 +419,7 @@ pytest proxy_test.py --proxy=proxy1
```
-### Changing the User-Agent:
+### Changing the User-Agent:
If you wish to change the User-Agent for your browser tests (Chrome and Firefox only), you can add ``--agent="USER AGENT STRING"`` as an argument on the command-line.
```bash
@@ -427,14 +427,14 @@ pytest user_agent_test.py --agent="Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1
```
-### Building Guided Tours for Websites:
+### Building Guided Tours for Websites:
Learn about SeleniumBase Interactive Walkthroughs (in the ``examples/tour_examples`` folder). It's great for prototyping a website onboarding experience.
-### Production Environments & Integrations:
+### Production Environments & Integrations:
Here are some things you can do to setup a production environment for your testing:
@@ -456,7 +456,7 @@ pytest [YOUR_TEST_FILE].py --with-db-reporting --with-s3-logging
-### Detailed Method Specifications and Examples:
+### Detailed Method Specifications and Examples:
#### Navigating to a web page (and related commands)
@@ -722,7 +722,7 @@ pytest --reruns 5 --reruns-delay 1
Additionally, you can use the ``@retry_on_exception()`` decorator to specifically retry failing methods. (First import: ``from seleniumbase import decorators``) To learn more about SeleniumBase decorators, [click here](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/common).
-### Wrap-Up
+### Wrap-Up
#### Congratulations on getting started with SeleniumBase!
diff --git a/docs/img/sb_icon.png b/docs/img/sb_icon.png
new file mode 100644
index 0000000000000000000000000000000000000000..212ce72ee40c4ead246403d6bbaea2b1159a9a71
GIT binary patch
literal 267
zcmeAS@N?(olHy`uVBq!ia0vp^av;pX1SGcvS$+jljKx9jP7LeL$-D$|j(WN{hIsHM
z`*?dNFW^mB)Von3I5We9`_5HAR^x{`UJ}36mN;*@eDtcoYNf1>(vMwYOj?;QUM fePRn=1{rVBn{)SM;TR<|Gr+DJM<-;4Yoh6;>jp3C%=If
z6p*ojVpN-_^X Z!!06
zG|b@Xm#GWz(2#l_Z&=JeA&g1$d){*u*=M1m>In~DE{7e7mC5>-C*=^!T9EpLw9U2@
zP&Dv<_}%{dJsS8j?Ueas_YOEFfKTXv&m~BaSmWT|TS84IK-gTzc9RhL899skdCu1O
zVINCmB%s!)OD9|f0V*gq^13^`){9%5uzd+P-jB`KX|fi#d)S~m#U&lu>K;XNN*seHaze6
ztlQKn>m2+HWiS#@@7D~kjX8%wi5CTi?Q
tn5&AC5#z>>;
zU%W)d{GB}}@xF0;PMq}U?RQeGHN#N_^Szc>a`qmBw2hFM%Kc5i=9Mx&DxTk;`7T>1
z9)8Sd&r$blpbsTOJ}|BE9@ZA%*;Rx#FpbIlTlt^s+JyMyt?PW$&HJfoq^|-lPn)!{
zTXwJ?vvTRL*K3|XnL5X&QWR{gkm67RIP475wer;pzm_CWT>PG7X5eSdks8Akbo2EE
z7&G(mWt@`xVOS$h36ot;&+`pU`Tjc<`W>cUk
%bUcST~Op3+?clk{?71uO-v+KL3|8He(o#mF$9bGjX*k=O`
z_8zP9-kw~QPIi7{ezs!1)C-7T^+Ul>u-d3n8lUI;{0-ZNz>Qk&9^lcuDY^urIGKj(
zpiF)}Ap87iHNg#f`a>5KgoWQ7i7}x!KT})8tm7?EC
z`2^)Q6D)dG8EZNZ`WKJ>{5tH}ti1KcRYXuV(@1v`pl&y`%Vhi_bYo&Y67y(^g2skz
zDu0Ko2*6Yg@ZRe59_10jd1BB@>ais`-4|SC%BjM9+SK*Un8nXL<4B4&$(SaSN8eL3
z7$g$og@8*?>ZYT5Q-j#}j-76=bqm*nLM6!uQ6tu$y0WijkF&Rsa!jr`m9jXNY*vM$
zfn<{sD|dZjgLhFrr~f%N0uPH{7|${P3&&4WO;ZNSx%P=)Aw>1)rJbM}9O@@iq`1G*
z;jF&7R^-%MS+rU%KDdr@