Skip to content

Commit 7d9095d

Browse files
committed
Update documentation
1 parent ef0223e commit 7d9095d

File tree

4 files changed

+32
-26
lines changed

4 files changed

+32
-26
lines changed

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<meta property="og:site_name" content="SeleniumBase">
22
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
33
<meta property="og:description" content="Fast, easy, and reliable Web/UI testing with Python." />
4-
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, RPA, behave, nosetests, dashboard, recorder, reports, gui">
4+
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, RPA, behave, BDD, nosetests, dashboard, recorder, reports, gui, screenshots">
55
<meta property="og:image" content="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" />
66
<link rel="icon" href="https://seleniumbase.io/img/green_logo.png" />
77

8-
<h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/mac_sb_logo_9.png" alt="SeleniumBase" title="SeleniumBase" width="340" /></a></h3>
8+
<h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/nice_logo_4t.png" alt="SeleniumBase" title="SeleniumBase" width="260" /></a></h3>
99
<!-- View on GitHub -->
1010

11-
<p align="center"><div align="center">Python framework for <a href="https://www.selenium.dev/documentation/" target="_blank">Selenium</a>. Supports <a href="https://docs.pytest.org/en/stable/" target="_blank">pytest</a> and <a href="https://behave.readthedocs.io/en/stable/index.html" target="_blank">behave-BDD</a>.</div></p>
11+
<p align="center"><div align="center">A Python ecosystem for <a href="https://www.selenium.dev/documentation/" target="_blank">Selenium</a> that extends <a href="https://docs.pytest.org/en/stable/" target="_blank">Pytest</a> and <a href="https://behave.readthedocs.io/en/stable/index.html" target="_blank">Behave</a>.</div></p>
1212

1313
<p align="center">
1414
<a href="https://github.com/seleniumbase/SeleniumBase/releases">
@@ -47,7 +47,7 @@
4747

4848
--------
4949

50-
<p align="left">↘️ Example test with the <b>BaseCase</b> class. Runs with <code>pytest</code> or <code>nosetests</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">Learn more</a>)</p>
50+
<p align="left">🌱 An example with <b>BaseCase</b>, a subclass of <code>unittest.TestCase</code>. Runs with <code>pytest</code> or <code>nosetests</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">Learn more</a>)</p>
5151

5252
```python
5353
from seleniumbase import BaseCase
@@ -64,7 +64,7 @@ class TestMFALogin(BaseCase):
6464
self.save_screenshot_to_logs()
6565
```
6666

67-
<p align="left">↘️ Example test with the <b>sb</b> pytest fixture. Runs with <code>pytest</code>.</p>
67+
<p align="left">🌱 An example with <b>sb</b>, a <code>pytest</code> fixture. Runs with <code>pytest</code>.</p>
6868

6969
```python
7070
def test_mfa_login(sb):
@@ -78,20 +78,20 @@ def test_mfa_login(sb):
7878
sb.save_screenshot_to_logs()
7979
```
8080

81-
<p align="left">↘️ Example test with <b>behave-BDD</b> <a href="https://behave.readthedocs.io/en/stable/gherkin.html">Gherkin</a> structure. Runs with <code>behave</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">Learn more</a>)</p>
81+
<p align="left">🌱 An example with <b>behave-BDD</b> <a href="https://behave.readthedocs.io/en/stable/gherkin.html">Gherkin</a> structure. Runs with <code>behave</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">Learn more</a>)</p>
8282

8383
```gherkin
8484
Feature: SeleniumBase scenarios for the RealWorld App
8585
86-
Scenario: Verify RealWorld App (log in / sign out)
87-
Given Open "seleniumbase.io/realworld/login"
88-
When Type "demo_user" into "#username"
89-
And Type "secret_pass" into "#password"
90-
And Do MFA "GAXG2MTEOR3DMMDG" into "#totpcode"
91-
Then Assert exact text "Welcome!" in "h1"
92-
And Highlight "img#image1"
93-
And Click 'a:contains("This Page")'
94-
And Save screenshot to logs
86+
Scenario: Verify RealWorld App (log in / sign out)
87+
Given Open "seleniumbase.io/realworld/login"
88+
When Type "demo_user" into "#username"
89+
And Type "secret_pass" into "#password"
90+
And Do MFA "GAXG2MTEOR3DMMDG" into "#totpcode"
91+
Then Assert exact text "Welcome!" in "h1"
92+
And Highlight "img#image1"
93+
And Click 'a:contains("This Page")'
94+
And Save screenshot to logs
9595
```
9696

9797
<p align="left">✅ An example of running a test: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py">test_demo_site.py</a></p>
@@ -431,6 +431,8 @@ The code above will leave your browser window open in case there's a failure. (i
431431
--block-images # (Block images from loading during tests.)
432432
--verify-delay=SECONDS # (The delay before MasterQA verification checks.)
433433
--recorder # (Enables the Recorder for turning browser actions into code.)
434+
--rec-behave # (Same as Recorder Mode, but also generates behave-gherkin.)
435+
--rec-sleep # (If the Recorder is enabled, also records self.sleep calls.)
434436
--disable-csp # (Disable the Content Security Policy of websites.)
435437
--disable-ws # (Disable Web Security on Chromium-based browsers.)
436438
--enable-ws # (Enable Web Security on Chromium-based browsers.)
@@ -1022,11 +1024,13 @@ pytest --reruns=1 --reruns-delay=1
10221024
<img src="https://img.shields.io/badge/docs-%20%20SeleniumBase.io-11BBDD.svg" alt="SeleniumBase.io Docs" /></a></div> <div><a href="https://pepy.tech/project/seleniumbase" target="_blank"><img src="https://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a></div>
10231025
10241026
<p><div>
1025-
<span><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.io/img/social/share_github.svg" title="SeleniumBase on GitHub" alt="SeleniumBase on GitHub" width="38" /></a></span>
1026-
<span><a href="https://www.facebook.com/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_facebook.svg" title="SeleniumBase on Facebook" alt="SeleniumBase on Facebook" width="36" /></a></span>
1027-
<span><a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="30" /></a></span>
1028-
<span><a href="https://instagram.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_instagram.svg" title="SeleniumBase on Instagram" alt="SeleniumBase on Instagram" width="32" /></a></span>
1029-
<span><a href="https://twitter.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_twitter.svg" title="SeleniumBase on Twitter" alt="SeleniumBase on Twitter" width="39" /></a></span>
1027+
<span><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.io/img/social/share_github.svg" title="SeleniumBase on GitHub" alt="SeleniumBase on GitHub" width="40" /></a></span>
1028+
<span><a href="https://www.facebook.com/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_facebook.svg" title="SeleniumBase on Facebook" alt="SeleniumBase on Facebook" width="37" /></a></span>
1029+
<span><a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="32" /></a></span>
1030+
<span><a href="https://instagram.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_instagram.svg" title="SeleniumBase on Instagram" alt="SeleniumBase on Instagram" width="33" /></a></span>
1031+
<span><a href="https://twitter.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_twitter.svg" title="SeleniumBase on Twitter" alt="SeleniumBase on Twitter" width="40" /></a></span>
10301032
</div></p>
10311033
10321034
<a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="200" /></a>
1035+
1036+
<p><b>Build all the automation you want, with SeleniumBase.</b></p>

examples/example_logs/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ nosetests test_suite.py --report
102102

103103
--------
104104

105-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> 🔵🐝⚪ Behave Dashboard & Reports:</h3>
105+
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> 🐝⚪ Behave Dashboard & Reports:</h3>
106106

107107
(The [behave_bdd/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/behave_bdd) folder can be found in the [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder.)
108108

help_docs/customizing_test_runs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,8 @@ pytest my_first_test.py --settings-file=custom_settings.py
148148
--block-images # (Block images from loading during tests.)
149149
--verify-delay=SECONDS # (The delay before MasterQA verification checks.)
150150
--recorder # (Enables the Recorder for turning browser actions into code.)
151+
--rec-behave # (Same as Recorder Mode, but also generates behave-gherkin.)
152+
--rec-sleep # (If the Recorder is enabled, also records self.sleep calls.)
151153
--disable-csp # (Disable the Content Security Policy of websites.)
152154
--disable-ws # (Disable Web Security on Chromium-based browsers.)
153155
--enable-ws # (Enable Web Security on Chromium-based browsers.)

mkdocs.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
site_name: SeleniumBase Docs
33
site_url: https://seleniumbase.io
44
site_author: Michael Mintz
5-
site_description: A complete framework for end-to-end testing with Python, pytest, and WebDriver.
5+
site_description: A complete framework for end-to-end testing with Python, pytest, behave-BDD, and WebDriver.
66
# Repository information
77
repo_name: seleniumbase/SeleniumBase
88
repo_url: https://github.com/seleniumbase/SeleniumBase
@@ -82,7 +82,7 @@ nav:
8282
- Running Example Tests: examples/ReadMe.md
8383
- Command Line Options: help_docs/customizing_test_runs.md
8484
- Dashboard / Reports: examples/example_logs/ReadMe.md
85-
- SeleniumBase Commander: help_docs/commander.md
85+
- GUI / Commander: help_docs/commander.md
8686
- Console Scripts: seleniumbase/console_scripts/ReadMe.md
8787
- Syntax Formats: help_docs/syntax_formats.md
8888
- Recorder Mode: help_docs/recorder_mode.md
@@ -94,9 +94,9 @@ nav:
9494
- WebDriver Installation: help_docs/webdriver_installation.md
9595
- Verifying WebDriver: help_docs/verify_webdriver.md
9696
- How it Works: help_docs/how_it_works.md
97-
- Behave-BDD:
98-
- SBase Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md
99-
- SBase Behave-BDD GUI App: help_docs/behave_gui.md
97+
- Behave-BDD Integration:
98+
- Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md
99+
- Behave-BDD GUI App: help_docs/behave_gui.md
100100
- Languages:
101101
- Translations: help_docs/translations.md
102102
- Chinese Docs: help_docs/chinese.md

0 commit comments

Comments
 (0)