Skip to content

Commit 3cd8646

Browse files
committed
Update the docs
1 parent 92750db commit 3cd8646

2 files changed

Lines changed: 15 additions & 13 deletions

File tree

docs/index.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2783,24 +2783,20 @@
27832783

27842784

27852785

2786+
<h1>✅ SeleniumBase README</h1>
2787+
27862788
<p><meta property="og:site_name" content="SeleniumBase">
27872789
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
27882790
<meta property="og:description" content="Fast, easy, and reliable Web/UI testing with Python." />
27892791
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, dashboard, recorder, reports, screenshots">
27902792
<meta property="og:image" content="https://seleniumbase.github.io/cdn/img/mac_sb_logo_5b.png" />
27912793
<link rel="icon" href="https://seleniumbase.github.io/img/logo7.png" /></p>
2792-
<h1>SeleniumBase</h1>
2793-
27942794
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/nice_logo_8t.png" alt="SeleniumBase" width="424" /></a></p>
27952795

27962796
<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://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><br /> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></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://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/✅%20View%20Code-on%20GitHub%20🌎-02A79E.svg" alt="SeleniumBase on GitHub" /></a></p>
27972797
<p align="center"></p>
27982798

2799-
<h3 align="center">Stealthy automation that passes every bot detection test.</h3>
2800-
2801-
<table align="center"><tr><td>
2802-
<b>Verified using multiple different Chromium browsers:<br />Chrome, Chrome-for-Testing, Chromium, Edge, Brave.</b>
2803-
</td></tr></table>
2799+
<h3 align="center">Stealthy Chromium Automation and E2E Testing.</h3>
28042800

28052801
<p align="center">
28062802
<a href="#python_installation">🚀 Start</a> |
@@ -2839,8 +2835,9 @@ <h3 align="center">Stealthy automation that passes every bot detection test.</h3
28392835
</p>
28402836

28412837
<p>🐙 <a translate="no" href="examples/cdp_mode/ReadMe/"><b>CDP Mode</b></a> bypasses bot-detection and handles CAPTCHAs by driving the browser directly through the <a href="https://chromedevtools.github.io/devtools-protocol/" translate="no">Chrome DevTools Protocol</a>. Includes <a href="examples/cdp_mode/playwright/ReadMe/"><b><span translate="no">Stealthy Playwright Mode</span></b></a>, which extends these advanced anti-detection patches to Playwright scripts.</p>
2842-
<p>📚 The <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples">SeleniumBase/examples/</a> folder includes over 100 ready-to-run examples. Examples that start with <code>test_</code> or end with <code>_test.py</code>/<code>_tests.py</code> are specifically designed to run with <code>pytest</code>. Other examples run directly with raw <code>python</code> (those files generally start with <code>raw_</code> to avoid confusion).</p>
2843-
<p>🥷 Stealthy examples are located in <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/cdp_mode">SeleniumBase/examples/cdp_mode/</a>.</p>
2838+
<p>📚 The <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples">SeleniumBase/examples/</a> folder includes over 100 ready-to-run examples of E2E testing. Examples that start with <code>test_</code> or end with <code>_test.py</code>/<code>_tests.py</code> are specifically designed to run with <code>pytest</code>. Other examples run directly with raw <code>python</code> (those files generally start with <code>raw_</code> to avoid confusion).</p>
2839+
<p>🥷 Stealthy CDP Mode examples are located in <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/cdp_mode">./examples/cdp_mode/</a>.</p>
2840+
<p>🎭 Stealthy Playwright examples are located in <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/">./examples/cdp_mode/playwright</a>.</p>
28442841
<hr />
28452842
<h3 align="left">⚙️ Stealthy architecture flowchart:</h3>
28462843

@@ -2861,7 +2858,7 @@ <h3 align="left">⚙️ Stealthy architecture flowchart:</h3>
28612858

28622859
<img src="https://seleniumbase.github.io/other/b_scan_results.jpg" width="628" alt="Stealthy architecture flowchart" />
28632860

2864-
📝 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/raw_browserscan_sync.py">This</a> also works as a drop-in replacement for Playwright (making it stealthy):
2861+
📝 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/raw_browserscan_sync.py">This example</a> demonstrates the drop-in patch that makes Playwright stealthy:
28652862

28662863
<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">playwright.sync_api</span><span class="w"> </span><span class="kn">import</span> <span class="n">sync_playwright</span>
28672864
<span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">sb_cdp</span>
@@ -2881,15 +2878,20 @@ <h3 align="left">⚙️ Stealthy architecture flowchart:</h3>
28812878

28822879
--------
28832880

2884-
For choosing which Chromium browser to use, you can set command-line options:
2881+
💡 You can set which Chromium browser to use via command-line options:
28852882

28862883
<div class="highlight"><pre><span></span><code>python<span class="w"> </span>SCRIPT.py<span class="w"> </span>--use-chromium<span class="w"> </span><span class="c1"># Use the unbranded Chromium browser</span>
28872884
python<span class="w"> </span>SCRIPT.py<span class="w"> </span>--cft<span class="w"> </span><span class="c1"># Use Chrome-for-testing</span>
28882885
python<span class="w"> </span>SCRIPT.py<span class="w"> </span>--edge<span class="w"> </span><span class="c1"># Use Microsoft Edge</span>
28892886
python<span class="w"> </span>SCRIPT.py<span class="w"> </span>--brave<span class="w"> </span><span class="c1"># Use Brave browser</span>
28902887
</code></pre></div>
28912888

2892-
(Google Chrome is the default browser if not specified.)
2889+
Google Chrome is the default browser if not specified. Only unbranded Chromium and Chrome-for-Testing are installed automatically if not already installed.
2890+
2891+
You can also set the browser via method args, eg: `cft=True`, `use_chromium=True`, `browser="edge"`, `browser="brave"`, etc. Eg:
2892+
2893+
<div class="highlight"><pre><span></span><code><span class="n">sb</span> <span class="o">=</span> <span class="n">sb_cdp</span><span class="o">.</span><span class="n">Chrome</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">use_chromium</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
2894+
</code></pre></div>
28932895

28942896
--------
28952897

docs/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)