Skip to content

Commit 3ec337a

Browse files
committed
Update the documentation
1 parent 5d1e5fb commit 3ec337a

9 files changed

+42
-27
lines changed

Diff for: README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,30 @@
1919
<p align="center">
2020
<a href="#python_installation">🚀 Start</a> |
2121
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🏰 Features</a> |
22-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">📚 Examples</a> |
2322
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">🎛️ Options</a> |
23+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">📚 Examples</a> |
2424
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">🌠 Scripts</a> |
2525
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">📱 Mobile</a>
2626
<br />
2727
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📘 APIs</a> |
28-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md"> 🔡 Formats</a> |
29-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Dashboard</a> |
28+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md"> 🔠 Formats</a> |
3029
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">🔴 Recorder</a> |
30+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Dashboard</a> |
3131
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> |
32-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a>
32+
<a href="https://seleniumbase.io/devices/?url=seleniumbase.com">💻 Farm</a>
3333
<br />
3434
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/commander.md">🎖️ GUI</a> |
3535
<a href="https://seleniumbase.io/demo_page">📰 TestPage</a> |
36-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/case_plans.md">🗂️ CasePlans</a> |
3736
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/uc_mode.md">👤 UC Mode</a> |
38-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🧬 Hybrid</a> |
39-
<a href="https://seleniumbase.io/devices/?url=seleniumbase.com">💻 Farm</a>
37+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md">🐙 CDP Mode</a> |
38+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">📶 Charts</a> |
39+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a>
4040
<br />
4141
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/how_it_works.md">👁️ How</a> |
4242
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/migration/raw_selenium">🚝 Migrate</a> |
43-
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Templates</a> |
44-
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js">🚉 NodeGUI</a> |
45-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">📶 Charts</a> |
43+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/case_plans.md">🗂️ CasePlans</a> |
44+
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Template</a> |
45+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🧬 Hybrid</a> |
4646
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🚎 Tours</a>
4747
<br />
4848
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI/CD</a> |

Diff for: help_docs/ReadMe.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<a href="https://seleniumbase.io/help_docs/method_summary/">📘 Methods / APIs</a> |
2121
<a href="https://seleniumbase.io/examples/tour_examples/ReadMe/">🚎 Tours</a>
2222
<br />
23-
<a href="https://seleniumbase.io/help_docs/syntax_formats/">🔡 Syntax Formats</a> |
23+
<a href="https://seleniumbase.io/help_docs/syntax_formats/">🔠 Syntax Formats</a> |
2424
<a href="https://seleniumbase.io/integrations/github/workflows/ReadMe/">🤖 CI/CD</a>
2525
<br />
2626
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
@@ -40,6 +40,8 @@
4040
<br / >
4141
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/commander.md">🎖️ GUI</a> |
4242
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/uc_mode.md">👤 UC Mode</a>
43+
<br / >
44+
<a href="https://seleniumbase.io/examples/cdp_mode/ReadMe/">🐙 CDP Mode</a>
4345
</p>
4446

4547
--------

Diff for: help_docs/customizing_test_runs.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) pytest options for SeleniumBase
44

5-
🎛️ SeleniumBase's [pytest plugin](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) lets you customize test runs from the CLI (Command-Line Interface), which adds options for setting/enabling the browser type, Dashboard Mode, Demo Mode, Headless Mode, Mobile Mode, Multi-threading Mode, Recorder Mode, reuse-session mode, proxy config, user agent config, browser extensions, html-report mode, and more.
5+
🎛️ SeleniumBase's [pytest plugin](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) lets you customize test runs from the CLI (Command-Line Interface), which adds options for setting/enabling the browser type, Dashboard Mode, Demo Mode, Headless Mode, Mobile Mode, Multi-threading Mode, Recorder Mode, UC Mode (stealth), reuse-session mode, Proxy Mode, and more.
66

77
🎛️ Here are some examples of configuring tests, which can be run from the [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder:
88

99
```bash
1010
# Run a test in Chrome (default browser)
1111
pytest my_first_test.py
1212

13-
# Run a test in Firefox
14-
pytest test_swag_labs.py --firefox
13+
# Run a test in Edge
14+
pytest test_swag_labs.py --edge
1515

1616
# Run a test in Demo Mode (highlight assertions)
1717
pytest test_demo_site.py --demo
@@ -31,23 +31,26 @@ pytest test_suite.py --rs --crumbs
3131
# Create a real-time dashboard for test results
3232
pytest test_suite.py --dashboard
3333

34-
# Create a pytest html report after tests are done
34+
# Create a pytest-html report after tests are done
3535
pytest test_suite.py --html=report.html
3636

37-
# Activate Debug Mode on failures ("c" to continue)
38-
pytest test_fail.py --pdb -s
39-
4037
# Rerun failing tests more times
4138
pytest test_suite.py --reruns=1
4239

43-
# Activate Debug Mode as the test begins ("n": next. "c": continue)
40+
# Activate Debug Mode at the start ("n": next. "c": continue)
4441
pytest test_null.py --trace -s
4542

43+
# Activate Debug Mode on failures ("n": next. "c": continue)
44+
pytest test_fail.py --pdb -s
45+
46+
# Activate Debug Mode at the end ("n": next. "c": continue)
47+
pytest test_fail.py --ftrace -s
48+
4649
# Activate Recorder/Debug Mode as the test begins ("c" to continue)
4750
pytest test_null.py --recorder --trace -s
4851

4952
# Pass extra data into tests (retrieve by calling self.data)
50-
pytest my_first_test.py --data="ABC,DEF"
53+
pytest my_first_test.py --data="ABC"
5154

5255
# Run tests on a local Selenium Grid
5356
pytest test_suite.py --server="127.0.0.1"
@@ -73,7 +76,7 @@ pytest test_swag_labs.py --mobile
7376
# Run mobile tests specifying CSS Width, CSS Height, and Pixel-Ratio
7477
pytest test_swag_labs.py --mobile --metrics="360,640,2"
7578

76-
# Run a test with an option to evade bot-detection services
79+
# Run tests using UC Mode to evade bot-detection services
7780
pytest verify_undetected.py --uc
7881

7982
# Run tests while changing SeleniumBase default settings

Diff for: help_docs/locale_codes.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,18 @@
22

33
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Language Locale Codes
44

5-
You can specify a Language Locale Code to customize web pages on supported websites. With SeleniumBase, you can change the web browser's Locale on the command line by doing this:
5+
You can specify a Language Locale Code to customize web pages on supported websites. With SeleniumBase, you can change the web browser's Locale on the command-line by doing this:
66

77
```bash
88
pytest --locale=CODE # Example: --locale=ru
99
```
1010

11+
From the ``SB()`` and ``Driver()`` formats, you can also set the ``locale_code`` arg like this:
12+
13+
```python
14+
locale_code="CODE" # Example: SB(locale_code="en")
15+
```
16+
1117
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="25" /> List of Language Locale Codes:</h3>
1218

1319
<table>

Diff for: help_docs/recorder_mode.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ sbase recorder
5959
6060
⏺️ While a recording is in progress, you can press the ``[ESC]`` key to pause the Recorder. To resume the recording, you can hit the ``[~`]`` key, which is located directly below the ``[ESC]`` key on most keyboards.
6161
62-
⏺️ From within Recorder Mode there are two additional modes: "Assert Element Mode" and "Assert Text Mode". To switch into "Assert Element Mode", press the ``[^]-key (SHIFT+6)``: The border will become purple, and you'll be able to click on elements to assert from your test. To switch into "Assert Text Mode", press the ``[&]-key (SHIFT+7)``: The border will become teal, and you'll be able to click on elements for asserting text from your test.
62+
⏺️ From within Recorder Mode there are two additional modes: "Assert Element Mode" and "Assert Text Mode". To switch into "Assert Element Mode", press the ``[^]-key (SHIFT+6 on standard QWERTY keyboards)``: The border will become purple, and you'll be able to click on elements to assert from your test. To switch into "Assert Text Mode", press the ``[&]-key (SHIFT+7 on standard QWERTY keyboards)``: The border will become teal, and you'll be able to click on elements for asserting text from your test.
6363
6464
⏺️ While using either of the two special Assertion Modes, certain actions such as clicking on links won't have any effect. This lets you make assertions on elements without navigating away from the page, etc. To add an assertion for buttons without triggering default "click" behavior, mouse-down on the button and then mouse-up somewhere else. (This prevents a detected click while still recording the assert.) To return back to the original Recorder Mode, press any key other than ``[SHIFT]`` or ``[BACKSPACE]`` (Eg: Press ``[CONTROL]``, etc.). Press ``[ESC]`` once to leave the Assertion Modes, but it'll stop the Recorder if you press it again.
6565
@@ -123,6 +123,8 @@ pytest TEST_NAME.py --trace --rec -s
123123
124124
⏺️ By launching the Recorder App with <code>sbase recorder --ee</code>, you can end the recording by pressing {<code>SHIFT</code>+<code>ESC</code>} instead of the usual way of ending the recording by typing <code>c</code> from a <code>breakpoint()</code> and pressing <code>Enter</code>. Those buttons don't need to be pressed at the same time, but <code>SHIFT</code> must be pressed directly before <code>ESC</code>.
125125
126+
⏺️ Use <code>sbase recorder --uc</code> to launch the Recorder App with UC Mode enabled. (The driver will be disconnected from Chrome, but the Recorder extension will still capture any browser actions.)
127+
126128
--------
127129
128130
<div>To learn more about SeleniumBase, check out the Docs Site:</div>

Diff for: help_docs/syntax_formats.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="40"> The 23 Syntax Formats / Design Patterns</h2>
66

7-
<h3>🔡 SeleniumBase supports multiple ways of structuring tests:</h3>
7+
<h3>🔠 SeleniumBase supports multiple ways of structuring tests:</h3>
88

99
<blockquote>
1010
<p dir="auto"></p>

Diff for: mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ nav:
115115
- 🎞️ Presentation Maker: examples/presenter/ReadMe.md
116116
- Integrations:
117117
- 👤 UC Mode: help_docs/uc_mode.md
118+
- 🐙 CDP Mode: examples/cdp_mode/ReadMe.md
118119
- 🤖 GitHub CI: integrations/github/workflows/ReadMe.md
119120
- 🛂 MasterQA: seleniumbase/masterqa/ReadMe.md
120121
- 🗂️ Case Plans: help_docs/case_plans.md

Diff for: mkdocs_build/requirements.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ pymdown-extensions>=10.11.2
66
pipdeptree>=2.23.4
77
python-dateutil>=2.8.2
88
Markdown==3.7
9-
markdown2==2.5.0
10-
MarkupSafe==2.1.5
9+
markdown2==2.5.1
10+
MarkupSafe==3.0.2
1111
Jinja2==3.1.4
1212
click==8.1.7
1313
ghp-import==2.1.0
@@ -20,7 +20,7 @@ lxml==5.3.0
2020
pyquery==2.0.1
2121
readtime==3.0.0
2222
mkdocs==1.6.1
23-
mkdocs-material==9.5.39
23+
mkdocs-material==9.5.42
2424
mkdocs-exclude-search==0.6.6
2525
mkdocs-simple-hooks==0.1.5
2626
mkdocs-material-extensions==1.3.1

Diff for: pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ dynamic = [
1313
"keywords",
1414
"classifiers",
1515
"description",
16+
"maintainers",
1617
"entry-points",
1718
"dependencies",
1819
"requires-python",

0 commit comments

Comments
 (0)