Skip to content

Commit 1e3d300

Browse files
committed
Update the docs
1 parent c4b9192 commit 1e3d300

File tree

2 files changed

+30
-31
lines changed

2 files changed

+30
-31
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
<meta property="og:image" content="https://seleniumbase.github.io/cdn/img/mac_sb_logo_5b.png" />
88
<link rel="icon" href="https://seleniumbase.github.io/img/logo7.png" />
99

10-
<h1>SeleniumBase</h1>
10+
<h1>📊 SeleniumBase</b></h1>
1111

12-
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb3.png" alt="SeleniumBase" title="SeleniumBase" width="400" /></a></p>
12+
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb3.png" alt="SeleniumBase" title="SeleniumBase" width="500" /></a></p>
1313

14-
<p align="center" class="hero__title"><b>All-in-one Browser Automation Framework:<br />Web Crawling / Testing / Scraping / Stealth</b></p>
14+
<h2 align="center" class="hero__title"><b>Browser automation and testing with stealth.</b></h2>
1515

16-
<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></p>
17-
<p align="center"><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://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/SeleniumBase?style=social"></a> <a href="https://pepy.tech/projects/seleniumbase?timeRange=threeMonths&category=version&includeCIDownloads=true&granularity=daily&viewType=line&versions=*" target="_blank"><img src="https://static.pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a> <a href="https://discord.gg/EdhQTn3EyE" target="_blank"><img src="https://img.shields.io/discord/727927627830001734?color=7289DA&label=Discord&logo=discord&logoColor=white"/></a></p>
16+
<p align="center"><a href="https://pepy.tech/projects/seleniumbase?timeRange=threeMonths&category=version&includeCIDownloads=true&granularity=daily&viewType=line&versions=*" target="_blank"><img src="https://static.pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a> <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/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></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://discord.gg/EdhQTn3EyE" target="_blank"><img src="https://img.shields.io/discord/727927627830001734?color=7289DA&label=Discord&logo=discord&logoColor=white"/></a></p>
17+
<p align="center"></p>
1818

1919
<p align="center">
2020
<a href="#python_installation">🚀 Start</a> |
@@ -52,15 +52,15 @@
5252
<br />
5353
</p>
5454

55-
<p><a href="https://github.com/seleniumbase/SeleniumBase/"><b translate="no">SeleniumBase</b></a> is an all-in-one Python framework for making browser automation, scraping, and testing significantly easier. Stealth options (like <a translate="no" href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md"><b translate="no">CDP Mode</b></a>) let you avoid bot-detection. Includes <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/ReadMe.md"><b><span translate="no">Stealthy Playwright Mode</span></b>.</p>
55+
📊 <a href="https://github.com/seleniumbase/SeleniumBase/"><b translate="no">SeleniumBase</b></a> is a complete framework for browser automation, testing, and web-scraping with Python. Includes multiple advanced modes and tools.
5656

57-
--------
57+
🐙 Stealth modes: <a translate="no" href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/uc_mode.md">UC Mode</a> and <a translate="no" href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md"><b>CDP Mode</b></a> can bypass bot-detection, solve CAPTCHAs, and call methods from the <a href="https://chromedevtools.github.io/devtools-protocol/" translate="no">Chrome Devtools Protocol</a>. Includes <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/ReadMe.md"><b><span translate="no">Stealthy Playwright Mode</span></b></a>, which makes Playwright stealthy via CDP Mode.
5858

59-
📚 Learn from [**over 200 examples** in the **SeleniumBase/examples/** folder](https://github.com/seleniumbase/SeleniumBase/tree/master/examples).
59+
ℹ️ Some <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">Syntax Formats</a> use <a href="https://docs.pytest.org/en/latest/how-to/usage.html" translate="no"><b>pytest</b></a> (a Python unit-testing framework included with SeleniumBase that can discover, collect, and run tests automatically).
6060

61-
🐙 Stealth modes: <a translate="no" href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/uc_mode.md"><b>UC Mode</b></a> and <a translate="no" href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md"><b>CDP Mode</b></a> can bypass bot-detection, solve CAPTCHAs, and call advanced methods from the <a href="https://chromedevtools.github.io/devtools-protocol/" translate="no">Chrome Devtools Protocol</a>.
61+
📚 Example scripts & tests are located in [**SeleniumBase/examples/**](https://github.com/seleniumbase/SeleniumBase/tree/master/examples).
6262

63-
ℹ️ Some <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">Syntax Formats</a> use <a href="https://docs.pytest.org/en/latest/how-to/usage.html" translate="no"><b>pytest</b></a> (a Python unit-testing framework included with SeleniumBase that can discover, collect, and run tests automatically).
63+
👤 The stealthy examples are located in [**SeleniumBase/examples/cdp_mode/**](https://github.com/seleniumbase/SeleniumBase/tree/master/examples).
6464

6565
--------
6666

@@ -188,9 +188,7 @@ pytest test_demo_site.py
188188

189189
<p align="left">📓 Here's a high-level stealthy architecture overview of SeleniumBase:</p>
190190

191-
192-
193-
<img src="https://seleniumbase.github.io/other/sb_stealth.png" width="650" alt="High-Level Stealthy Architecture Overview" title="High-Level Stealthy Architecture Overview" />
191+
<img src="https://seleniumbase.github.io/other/sb_stealth.png" width="585" alt="High-Level Stealthy Architecture Overview" title="High-Level Stealthy Architecture Overview" />
194192

195193
(For maximum stealth, use <a translate="no" href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md">CDP Mode</a>, which is used by <a translate="no" href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/ReadMe.md">Stealthy Playwright Mode</a>)
196194

examples/ReadMe.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

55
<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>
66

7-
* <b>SeleniumBase</b> tests are run with <b>pytest</b>.
7+
* <b>SeleniumBase</b> "tests" are run with <b>pytest</b>.
88
* Chrome is the default browser if not specified.
99
* Tests are structured using [25 unique syntax formats](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md).
10-
* Logs from test failures are saved to ``./latest_logs/``.
10+
* Logs from test failures are saved to `./latest_logs/`.
1111
* Tests can be run with [multiple command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
12-
* Examples can be found in: **[SeleniumBase/examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples)**.
12+
* Examples can be found in [SeleniumBase/examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples).
13+
* For stealthy examples, see [SeleniumBase/examples/cdp_mode/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/cdp_mode).
1314

1415
(NOTE: Some example tests fail on purpose to demonstrate [logging features](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).)
1516

@@ -19,7 +20,7 @@
1920

2021
--------
2122

22-
Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py): (Default option: ``--chrome``)
23+
Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py): (Default option: `--chrome`)
2324

2425
```zsh
2526
pytest my_first_test.py
@@ -47,7 +48,7 @@ pytest test_demo_site.py
4748

4849
--------
4950

50-
Run an example test in ``--demo`` mode: (highlight assertions)
51+
Run an example test in `--demo` mode: (highlight assertions)
5152

5253
```zsh
5354
pytest test_swag_labs.py --demo
@@ -77,7 +78,7 @@ pytest wordle_test.py
7778

7879
--------
7980

80-
Run an example test in ``--headless`` mode: (invisible browser)
81+
Run an example test in `--headless` mode: (invisible browser)
8182

8283
```zsh
8384
pytest my_first_test.py --headless
@@ -95,7 +96,7 @@ pytest test_swag_labs.py --mobile
9596

9697
--------
9798

98-
Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_xkcd.py) in ``--demo`` mode: (highlight assertions)
99+
Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_xkcd.py) in `--demo` mode: (highlight assertions)
99100

100101
```zsh
101102
pytest test_xkcd.py --demo
@@ -113,7 +114,7 @@ pytest test_suite.py -v
113114

114115
--------
115116

116-
Run a test suite using multiple parallel processes (``-n=NUM``):
117+
Run a test suite using multiple parallel processes (`-n=NUM`):
117118

118119
```zsh
119120
pytest test_suite.py -n=8
@@ -137,33 +138,33 @@ pytest test_suite.py --dashboard
137138

138139
--------
139140

140-
Run a test suite and generate a ``pytest`` report:
141+
Run a test suite and generate a `pytest` report:
141142

142143
```zsh
143144
pytest test_suite.py --html=report.html
144145
```
145146

146147
--------
147148

148-
Run a [failing test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_fail.py): (See the ``latest_logs/`` folder for logs and screenshots)
149+
Run a [failing test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_fail.py): (See the `latest_logs/` folder for logs and screenshots)
149150

150151
```zsh
151152
pytest test_fail.py
152153
```
153154

154155
--------
155156

156-
Run a failing test that activates ``pdb`` debug mode on failure:
157+
Run a failing test that activates `pdb` debug mode on failure:
157158

158159
```zsh
159160
pytest test_fail.py --pdb -s
160161
```
161162

162-
> (**``pdb``** commands: ``n``, ``c``, ``s``, ``u``, ``d`` => ``next``, ``continue``, ``step``, ``up``, ``down``)
163+
> (**`pdb`** commands: `n`, `c`, `s`, `u`, `d` => `next`, `continue`, `step`, `up`, `down`)
163164
164165
--------
165166

166-
Run a test suite that demonstrates the use of ``pytest`` markers:
167+
Run a test suite that demonstrates the use of `pytest` markers:
167168

168169
```zsh
169170
pytest -m marker_test_suite -v
@@ -179,7 +180,7 @@ pytest test_suite.py --rs
179180

180181
--------
181182

182-
Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/rate_limiting_test.py) demonstrating the ``rate_limited`` Python decorator:
183+
Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/rate_limiting_test.py) demonstrating the `rate_limited` Python decorator:
183184

184185
```zsh
185186
pytest rate_limiting_test.py
@@ -195,7 +196,7 @@ pytest upload_file_test.py
195196

196197
--------
197198

198-
🎖️ **SeleniumBase Commander** is a GUI for ``pytest``:
199+
🎖️ **SeleniumBase Commander** is a GUI for `pytest`:
199200

200201
```zsh
201202
sbase gui
@@ -205,23 +206,23 @@ sbase gui
205206

206207
--------
207208

208-
<b>SeleniumBase tests can also be run with ``pynose``:</b>
209+
<b>SeleniumBase tests can also be run with `pynose`:</b>
209210

210211
```zsh
211212
pynose my_first_test.py
212213
```
213214

214215
--------
215216

216-
Run an example test suite and generate a ``pynose`` test report:
217+
Run an example test suite and generate a `pynose` test report:
217218

218219
```zsh
219220
pynose test_suite.py --report --show-report
220221
```
221222

222223
--------
223224

224-
Run an example test using a ``pynose`` configuration file:
225+
Run an example test using a `pynose` configuration file:
225226

226227
```zsh
227228
pynose my_first_test.py --config=example_config.cfg

0 commit comments

Comments
 (0)