Skip to content

Commit c654908

Browse files
mdmintzmdmintz
committed
Update the docs
1 parent 127e245 commit c654908

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+316
-140
lines changed

‎README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
<meta property="og:site_name" content="SeleniumBase">
24
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
35
<meta property="og:description" content="Fast, easy, and reliable Web/UI testing with Python." />
@@ -14,7 +16,7 @@
1416
<p align="center"><a href="https://pypi.python.org/pypi/seleniumbase" target="_blank"><img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=3399EE" alt="PyPI version" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases" target="_blank"><img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=22AAEE" alt="GitHub version" /></a> <a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a></p>
1517

1618
<p align="center">
17-
<a href="#python_installation">🚀 Start</a> |
19+
<a href="#python_installation">🏄 Start</a> |
1820
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🏰 Features</a> |
1921
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">📚 Examples</a> |
2022
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">🎛️ Options</a> |
@@ -202,22 +204,22 @@ Feature: SeleniumBase scenarios for the RealWorld App
202204

203205
**You can install ``seleniumbase`` from [GitHub](https://github.com/seleniumbase/SeleniumBase) or [PyPI](https://pypi.org/project/seleniumbase/):**
204206

205-
🔵 Installing ``seleniumbase`` from a GitHub clone:
207+
🔵 **Installing ``seleniumbase`` from a GitHub clone:**
206208

207209
```bash
208210
git clone https://github.com/seleniumbase/SeleniumBase.git
209211
cd SeleniumBase/
210212
pip install -e .
211213
```
212214

213-
To upgrade an existing install from a GitHub clone:
215+
**To upgrade an existing install from a GitHub clone:**
214216

215217
```bash
216218
git pull
217219
pip install -e .
218220
```
219221

220-
🔵 Installing ``seleniumbase`` from PyPI:
222+
🔵 **Installing ``seleniumbase`` from PyPI:**
221223

222224
```bash
223225
pip install seleniumbase
@@ -227,7 +229,7 @@ pip install seleniumbase
227229
* (Add ``--force-reinstall`` to upgrade indirect libraries.)
228230
* (Use ``pip3`` if multiple versions of Python are present.)
229231

230-
To upgrade an existing install from PyPI:
232+
**To upgrade an existing install from PyPI:**
231233

232234
```bash
233235
pip install -U seleniumbase
@@ -283,7 +285,7 @@ COMMANDS:
283285
284286
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> Downloading web drivers:</h3>
285287
286-
✅ SeleniumBase automatically downloads web drivers as needed, such as ``chromedriver`` and ``geckodriver`` (Firefox).
288+
✅ SeleniumBase automatically downloads web drivers as needed, such as ``chromedriver``, ``edgedriver``, and ``geckodriver``.
287289
288290
✅ To manually download a webdriver, see [Console Scripts](https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/) OR [Webdriver Installation](https://seleniumbase.io/help_docs/webdriver_installation/).
289291

‎examples/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Example Tests:
24

35
<p align="left"><a align="center" href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py"><img align="center" src="https://seleniumbase.github.io/cdn/img/sb_demo_page.png" alt="SeleniumBase Demo Page" width="420" /></a></p>

‎examples/behave_bdd/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 🐝 Behave test runner for SeleniumBase 🐝
24

35
🐝 (Utilizes the [Behave BDD Python library](https://github.com/behave/behave). For more info, see the [Behave tutorial](https://behave.readthedocs.io/en/stable/tutorial.html) and read about [Behave's Gherkin model](https://behave.readthedocs.io/en/stable/gherkin.html).)

‎examples/boilerplates/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
<img src="https://seleniumbase.io/cdn/img/sb_text_f.png" title="SeleniumBase" align="center" width="290">
24

35
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Example Boilerplates:</h2>

‎examples/capabilities/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
<h3><img src="https://seleniumbase.io/img/green_logo.png" title="SeleniumBase" width="32" /> Using Desired Capabilities</h3>
24

35
You can specify browser capabilities when running SeleniumBase tests on a remote Selenium Grid server such as <a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack</a>, <a href="https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/" target="_blank">Sauce Labs</a>, or another.

‎examples/chart_maker/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 📊 ChartMaker 📶
24

35
<p>SeleniumBase ChartMaker lets you use Python to generate HTML charts.</p>

‎examples/dialog_boxes/ReadMe.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 🛂 Dialog Boxes 🛂
1+
<!-- SeleniumBase Docs -->
2+
3+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32"> 🛂 Dialog Boxes 🛂</h2>
24

35
SeleniumBase Dialog Boxes let your users provide input in the middle of automation scripts.
46

57
* This feature utilizes the [jquery-confirm](https://craftpip.github.io/jquery-confirm/) library.
68
* A Python API is used to call the JavaScript API.
79

8-
<img src="https://seleniumbase.io/cdn/img/emoji_sports_dialog.png" alt="SeleniumBase" width="400" />
10+
<img src="https://seleniumbase.github.io/cdn/img/emoji_sports_dialog.png" alt="SeleniumBase" width="400" />
911

1012
<h4>↕️ (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/dialog_boxes/dialog_box_tour.py">Example: dialog_box_tour.py</a>) ↕️</h4>
1113

12-
<img src="https://seleniumbase.io/cdn/gif/sports_dialog.gif" alt="SeleniumBase" width="400" />
14+
<img src="https://seleniumbase.github.io/cdn/gif/sports_dialog.gif" alt="SeleniumBase" width="400" />
1315

1416
<h4>Here's how to run that example:</h4>
1517

@@ -175,4 +177,4 @@ self.activate_jquery_confirm() # Automatic for jqc methods
175177
--------
176178

177179
<h4>✅ 🛂 Automated/Manual Hybrid Mode (MasterQA)</h4>
178-
<p><b><a href="https://seleniumbase.io/seleniumbase/masterqa/ReadMe/">MasterQA</a></b> uses <b>SeleniumBase Dialog Boxes</b> to speed up manual testing by having automation perform all the browser actions while the manual tester handles validation. See <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/master_qa">the MasterQA GitHub page</a> for examples.</p>
180+
<p><b><a href="https://seleniumbase.github.io/seleniumbase/masterqa/ReadMe/">MasterQA</a></b> uses <b>SeleniumBase Dialog Boxes</b> to speed up manual testing by having automation perform all the browser actions while the manual tester handles validation. See <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/master_qa">the MasterQA GitHub page</a> for examples.</p>

‎examples/example_logs/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Logs, The Dashboard, and Reports:
24

35
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=XpuJCjJhJwQ"><img src="http://img.youtube.com/vi/XpuJCjJhJwQ/0.jpg" title="SeleniumBase on YouTube" width="285" /></a>

‎examples/master_qa/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
![](https://seleniumbase.io/cdn/img/masterqa_logo.png "MasterQA")
24

35
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> MasterQA combines automation with manual verification steps.</h3>

‎examples/migration/raw_selenium/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## ✅ Support for migrating from raw Selenium to SeleniumBase
24

35

‎examples/presenter/ReadMe.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 📑 Presenter 🎞️
1+
<!-- SeleniumBase Docs -->
2+
3+
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 📑 Presenter 🎞️
24

35
<p>SeleniumBase Presenter (slide-maker) lets you use Python to generate HTML presentations.</p>
46

57
<b>Here's a sample presentation:</b>
68

7-
<a href="https://seleniumbase.io/other/presenter.html"><img width="500" src="https://seleniumbase.io/other/presenter.gif" title="Screenshot"></a><br>
9+
<a href="https://seleniumbase.github.io/other/presenter.html"><img width="500" src="https://seleniumbase.io/other/presenter.gif" title="Screenshot"></a><br>
810

911
([Click on the image/GIF for the actual presentation](https://seleniumbase.io/other/presenter.html))
1012

@@ -21,7 +23,7 @@ pytest my_presentation.py
2123

2224
**Here's a presentation with a chart:**
2325

24-
<a href="https://seleniumbase.io/other/core_presentation.html"><img width="428" src="https://seleniumbase.io/other/sb_core_areas.png" title="Screenshot"></a><br>
26+
<a href="https://seleniumbase.github.io/other/core_presentation.html"><img width="428" src="https://seleniumbase.io/other/sb_core_areas.png" title="Screenshot"></a><br>
2527

2628
([Click on the image/GIF for the actual presentation](https://seleniumbase.io/other/core_presentation.html))
2729

@@ -35,7 +37,7 @@ pytest core_presentation.py
3537
```
3638

3739

38-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="24" /> Creating a new presentation:</h3>
40+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="24" /> Creating a new presentation:</h3>
3941

4042
```python
4143
self.create_presentation(name=None, theme="serif", transition="default")
@@ -58,7 +60,7 @@ Notes are disabled by default. You can enable notes by specifying:
5860
``show_notes=True``
5961

6062

61-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="24" /> Adding a slide to a presentation:</h3>
63+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="24" /> Adding a slide to a presentation:</h3>
6264

6365
```python
6466
self.add_slide(content=None, image=None, code=None, iframe=None,
@@ -81,7 +83,7 @@ self.add_slide(content=None, image=None, code=None, iframe=None,
8183
"""
8284
```
8385

84-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="24" /> Running a presentation:</h3>
86+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="24" /> Running a presentation:</h3>
8587

8688
```python
8789
self.begin_presentation(
@@ -104,7 +106,7 @@ Before the presentation is run, the full HTML is saved to the ``saved_presentati
104106

105107
All methods have the optional ``name`` argument, which is only needed if you're creating multiple presentations at once.
106108

107-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="24" /> Here's an example of using SeleniumBase Presenter:</h3>
109+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="24" /> Here's an example of using SeleniumBase Presenter:</h3>
108110

109111
```python
110112
from seleniumbase import BaseCase
@@ -229,7 +231,7 @@ That example is from [my_presentation.py](https://github.com/seleniumbase/Seleni
229231
pytest my_presentation.py
230232
```
231233

232-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="24" /> Saving a presentation:</h3>
234+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="24" /> Saving a presentation:</h3>
233235

234236
If you want to save the presentation you created as an HTML file, use:
235237

@@ -245,4 +247,4 @@ self.begin_presentation(show_notes=True)
245247

246248
--------
247249

248-
<h3 align="left"><img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="240" /></h3>
250+
<h3 align="left"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="240" /></h3>

‎examples/tour_examples/ReadMe.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<h3 align="left"><img src="https://seleniumbase.io/cdn/img/g_maps_tour.png" alt="SeleniumBase Tour" width="340" /></h3>
1+
<!-- SeleniumBase Docs -->
2+
3+
<h3 align="left"><img src="https://seleniumbase.github.io/cdn/img/g_maps_tour.png" alt="SeleniumBase Tour" width="340" /></h3>
24

35
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Interactive Product Tours 🚎
46

@@ -10,7 +12,7 @@
1012
1113
<b>A tour demo: (with autoplay)</b>
1214

13-
<img src="https://seleniumbase.io/cdn/gif/introjs_tour.gif" title="SeleniumBase Tour of Google"><br>
15+
<img src="https://seleniumbase.github.io/cdn/gif/introjs_tour.gif" title="SeleniumBase Tour of Google"><br>
1416

1517
[SeleniumBase maps_introjs_tour.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/maps_introjs_tour.py)
1618

@@ -21,7 +23,7 @@ pytest maps_introjs_tour.py --interval=1
2123

2224
<b>Here's a longer version:</b>
2325

24-
<img src="https://seleniumbase.io/cdn/gif/google_tour_4.gif" title="SeleniumBase Tour of Google"><br>
26+
<img src="https://seleniumbase.github.io/cdn/gif/google_tour_4.gif" title="SeleniumBase Tour of Google"><br>
2527

2628
[SeleniumBase google_tour.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/google_tour.py)
2729

@@ -142,6 +144,6 @@ OR
142144
143145
--------
144146

145-
<img src="https://seleniumbase.io/cdn/gif/driverjs_tour_2.gif" title="SeleniumBase Tour of Google"><br>
147+
<img src="https://seleniumbase.github.io/cdn/gif/driverjs_tour_2.gif" title="SeleniumBase Tour of Google"><br>
146148

147-
<h3 align="left"><img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="320" /></h3>
149+
<h3 align="left"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="320" /></h3>

‎examples/unit_tests/ReadMe.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1-
### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="20" /> pytest-specific unit tests
1+
<!-- SeleniumBase Docs -->
2+
3+
### <img src="https://seleniumbase.github.io/img/logo3.png" title="SeleniumBase" width="20" /> pytest-specific unit tests
24

35
The tests in this folder are for basic verification of the SeleniumBase framework with pytest.

‎examples/visual_testing/ReadMe.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/sb_logo_f6.png" alt="SeleniumBase" width="445" /></a></p>
24

35
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Automated Visual Regression Testing

‎help_docs/ReadMe.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Help Docs
24

35
<p align="left">
4-
<a href="https://seleniumbase.io/#python_installation">🚁 Start</a> |
5-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Dashboard</a>
6+
<a href="https://seleniumbase.io/#python_installation">🏄 Start</a> |
7+
<a href="https://seleniumbase.io/examples/example_logs/ReadMe/">📊 Dashboard</a>
68
<br />
79
<a href="https://seleniumbase.io/help_docs/features_list/">🏰 Features</a> |
810
<a href="https://seleniumbase.io/help_docs/customizing_test_runs/">🎛️ Options</a>
911
<br />
10-
<a href="https://seleniumbase.io/examples/ReadMe/">📖 Examples</a> |
12+
<a href="https://seleniumbase.io/examples/ReadMe/">📚 Examples</a> |
1113
<a href="https://seleniumbase.io/help_docs/mobile_testing/">📱 Mobile</a>
1214
<br />
13-
<a href="https://seleniumbase.io/help_docs/syntax_formats/">📝 Syntax Formats</a> |
15+
<a href="https://seleniumbase.io/help_docs/syntax_formats/">🔡 Syntax Formats</a> |
1416
<a href="https://seleniumbase.io/integrations/github/workflows/ReadMe/">🤖 CI/CD</a>
1517
<br />
16-
<a href="https://seleniumbase.io/help_docs/method_summary/">📙 APIs</a> |
17-
<a href="https://seleniumbase.io/examples/example_logs/ReadMe/">📊 Reports</a> |
18+
<a href="https://seleniumbase.io/help_docs/method_summary/">📗 Methods / APIs</a> |
1819
<a href="https://seleniumbase.io/examples/tour_examples/ReadMe/">🚎 Tours</a>
1920
<br />
2021
<a href="https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/">🔮 Console Scripts</a> |
@@ -29,11 +30,11 @@
2930
<a href="https://seleniumbase.io/help_docs/recorder_mode/">🔴 Recorder</a> |
3031
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js">🚉 Node GUI</a>
3132
<br />
32-
<a href="https://seleniumbase.io/help_docs/translations/">🈺 Translator</a> |
33+
<a href="https://seleniumbase.io/help_docs/translations/">🌏 Translator</a> |
3334
<a href="https://seleniumbase.io/examples/dialog_boxes/ReadMe/">🛂 Dialog Boxes</a>
3435
<br />
3536
<a href="https://seleniumbase.io/examples/presenter/ReadMe/">🎞️ Slides</a> |
36-
<a href="https://seleniumbase.io/examples/chart_maker/ReadMe/">📊 Charts</a>
37+
<a href="https://seleniumbase.io/examples/chart_maker/ReadMe/">📶 Charts</a>
3738
</p>
3839

3940
--------

‎help_docs/behave_gui.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) SeleniumBase Behave GUI / Commander 🐝🎖️
24

35
🐝🎖️ The <b>SeleniumBase Behave GUI</b> lets you run <code>behave</code> scripts from a Desktop GUI.<br>

‎help_docs/case_plans.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) SeleniumBase Case Plans 🗂️
24

35
<img src="https://seleniumbase.io/cdn/img/cp/sb_case_plans.png" title="SeleniumBase Case Plans Summary" width="625">

‎help_docs/chart_maker.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- SeleniumBase Docs -->
2+
13
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 📊 ChartMaker 📶
24

35
<p>SeleniumBase ChartMaker lets you use Python to generate HTML charts.</p>

0 commit comments

Comments
 (0)