Skip to content

Commit bb9af06

Browse files
committed
Update the docs
1 parent b898ba6 commit bb9af06

File tree

5 files changed

+41
-34
lines changed

5 files changed

+41
-34
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
11
<meta property="og:site_name" content="SeleniumBase">
22
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
3-
<meta property="og:description" content="Build fast, reliable, end-to-end tests." />
3+
<meta property="og:description" content="Fast, easy, and reliable Web/UI testing with Python." />
44
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, test automation, testing, seleniumbase, test framework, RPA, reports, website tours, presentations">
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/logo6.png" />
77

8-
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
9-
<img src="https://seleniumbase.io/img/sb_logo_10.png" alt="SeleniumBase" title="SeleniumBase" width="280" /></a></p>
10-
<p align="center">
11-
<b>Build fast, reliable, end-to-end tests.</b>
12-
</p>
8+
<h2 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="332" /></a></h2>
9+
<h3 align="center">Create web/mobile tests 8x faster.</h3>
10+
<h4 align="center">Bring <a href="https://www.selenium.dev/documentation/">Selenium</a> & <a href="https://docs.pytest.org/en/latest/index.html">pytest</a> to the next level.</h4>
1311
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/releases">
1412
<img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=2277EE" alt="Latest Release on GitHub" /></a> <a href="https://pypi.org/project/seleniumbase/">
15-
<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=00a0e0" alt="Latest Release on PyPI" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=19A57B" title="Stargazers" /></a></p>
13+
<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=00a0e0" alt="Latest Release on PyPI" /></a></p>
1614

1715
<!-- View on GitHub -->
1816
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/actions">
1917
<img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master"> <img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt="SeleniumBase Azure Pipelines" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase">
2018
<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a> <a href="https://seleniumbase.io">
2119
<img src="https://img.shields.io/badge/docs-%20seleniumbase.io-22BBAA.svg" alt="SeleniumBase.io Docs" /></a></p>
2220

21+
<p align="center">SeleniumBase is an all-in-one framework for Web/UI testing with Python.</p>
22+
2323
<p align="center">
2424
<a href="#python_installation">🚀 Start</a> |
25-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">📖 Examples</a> |
26-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🗂️ Features</a> |
25+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">👨‍🏫 Examples</a> |
26+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🏰 Features</a> |
2727
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">🖥️ CLI</a> |
28-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">💻 Scripts</a> |
28+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">🧙‍♂️ Scripts</a> |
2929
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">📱 Mobile</a> |
30-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🗄️ JSManager</a>
30+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🕹️ JSManager</a>
3131
<br />
32-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📗 API</a> |
32+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📚 API</a> |
3333
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Reports</a> |
3434
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
35-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">🔡 Syntaxes</a> |
35+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">🔠 Syntaxes</a> |
3636
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> |
3737
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a> |
3838
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md">⏺️ Record</a>
3939
<br />
4040
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI</a> |
4141
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/translations.md">🌏 Translate</a> |
4242
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🗺️ Tours</a> |
43-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/ReadMe.md">📑 Present</a> |
44-
<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/examples/chart_maker/ReadMe.md">📶 Charts</a> |
44+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/ReadMe.md">📰 Present</a> |
4545
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">🖼️ VisualTest</a> |
4646
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🛂 MasterQA</a>
4747
</p>
4848

4949
<p align="left">
50-
Get set up in minutes. <a href="https://www.youtube.com/watch?v=n-sno20R9P0">Deploy anywhere</a>.<br />
51-
Provides <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md"> browser testing APIs</a> for <a href="https://docs.pytest.org/">pytest</a>.<br />
50+
Smart-waiting code prevents flaky tests.<br />
51+
Can run on <a href="https://seleniumbase.io/integrations/github/workflows/ReadMe/">GHA</a>, <a href="https://seleniumbase.io/integrations/google_cloud/ReadMe/">GCP</a>, <a href="https://seleniumbase.io/integrations/azure/jenkins/ReadMe/">Azure</a>, & <a href="https://seleniumbase.io/integrations/docker/ReadMe/">Docker</a>.<br />
5252
✅ Supports Chromium, Firefox, IE, & Safari.<br />
5353
✅ Includes <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">dashboards and reporting tools</a>.
5454
</p>
@@ -90,7 +90,7 @@ class MyTestClass(BaseCase):
9090

9191
🔵 Add **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)** to your System PATH.
9292

93-
🔵 Create a **[Python virtual environment](https://seleniumbase.io/help_docs/virtualenv_instructions/)**.
93+
🔵 Using a [Python virtual env](https://seleniumbase.io/help_docs/virtualenv_instructions/) is recommended.
9494

9595
<a id="install_seleniumbase"></a>
9696
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Install SeleniumBase:</h2>
@@ -963,7 +963,7 @@ pytest --reruns=1 --reruns-delay=1
963963
964964
<p>
965965
<div><b>If you like us, give us a star!</b></div>
966-
<div><a href="https://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=888CFA" title="Stargazers" /></a></div>
966+
<div><a href="https://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=19A57B" title="Stargazers" /></a></div>
967967
</p>
968968
<p><div><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></div></p>
969969

examples/chart_maker/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h3 align="left"><img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="350" /></h3>
22

3-
<h2> 📊 ChartMaker 📈 </h2>
3+
<h2> 📊 ChartMaker 📶 </h2>
44

55
<p>SeleniumBase ChartMaker lets you use Python to generate HTML charts from HighCharts JS.</p>
66

help_docs/chart_maker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h3 align="left"><img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="350" /></h3>
22

3-
<h2> 📊 ChartMaker 📈 </h2>
3+
<h2> 📊 ChartMaker 📶 </h2>
44

55
<p>SeleniumBase ChartMaker lets you use Python to generate HTML charts from HighCharts JS.</p>
66

help_docs/happy_customers.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
<h4> Here are some organizations that have used SeleniumBase:</h4>
1+
<h4> Here are some organizations that have grown their automation with SeleniumBase:</h4>
22

33
* [MIT](https://web.mit.edu/)
44
* [iboss](https://www.iboss.com/)
5+
* [Akamai](https://www.akamai.com/)
56
* [HubSpot](https://www.hubspot.com/)
6-
* [Autodesk](https://www.autodesk.com/)
77
* [Veracode](https://www.veracode.com/)
8+
* [Autodesk](https://www.autodesk.com/)
89
* [Broadcom](https://www.broadcom.com/)
910
* [Thoma Bravo](https://www.thomabravo.com/)
1011
* [Expedia Group](https://lifeatexpediagroup.com/)
@@ -13,20 +14,26 @@
1314
* [Mississippi State University](https://www.msstate.edu/)
1415
* [Queen's University](https://www.queensu.ca/)
1516
* [L1NNA Laboratory](https://l1nna.com/)
17+
* [Thomson Reuters](https://www.thomsonreuters.com/)
1618
* [CA Technologies](https://www.ca.com/)
1719
* [Raid The Room](https://raidtheroom.com/)
1820
* [First American](https://www.firstam.com/)
1921
* [Origin Energy](https://www.originenergy.com.au/)
2022
* [InterSystems](https://www.intersystems.com/)
2123
* [StreamSets](https://streamsets.com/)
2224
* [NerdVision](https://www.nerd.vision/)
25+
* [Aeturnum](https://aeturnum.com/)
2326
* [Cellebrite](https://www.cellebrite.com/en/home/)
27+
* [Ben Fatto](http://www.benfatto.net.br)
2428
* [GeoNode](http://geonode.org/)
2529
* [VMware](https://www.vmware.com/)
30+
* [Nagarro](https://www.nagarro.com/en)
2631
* [Ark PES](https://www.arkpes.com/)
27-
* [Akamai](https://www.akamai.com/)
32+
* [Evereve](https://evereve.com/)
2833
* [WPILib](https://wpilib.org/)
2934
* [Yandex](https://yandex.ru/)
35+
* [netLex](https://netlex.io/en/)
36+
* [Cubic](https://www.cubic.com/)
3037
* [Baidu](https://www.baidu.com/)
3138
* [Iver](https://www.iver.com/)
3239
* [HqO](https://www.hqo.co/)
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
1-
### Running browser tests from [GitHub Actions/Workflows](https://github.com/seleniumbase/SeleniumBase/actions) with [SeleniumBase](https://github.com/seleniumbase/SeleniumBase)
1+
## Running browser tests on [GitHub Actions](https://github.com/seleniumbase/SeleniumBase/actions) with [SeleniumBase](https://github.com/seleniumbase/SeleniumBase)
22

3-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_7.png "GitHub Actions/Workflows")
3+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_7.png "GitHub Actions")
44

55
----------
66

77
### Step 0. Create a fork of [SeleniumBase](https://github.com/seleniumbase/SeleniumBase) on GitHub to help you get started.
88

99
* **(You'll be using your own repo eventually.)**
1010

11-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_2.png "Create a fork of SeleniumBase")
11+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_2.png "Create a fork of SeleniumBase")
1212

1313
----------
1414

1515
### Step 1. From the GitHub Actions tab, choose to set up a Python package Workflow.
1616

17-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_1.png "GitHub Actions/Workflows")
17+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_1.png "GitHub Actions")
1818

1919
----------
2020

2121
### Step 2. Add your workflow ``.yml`` script.
2222

2323
* **(If using a SeleniumBase fork, the script from https://github.com/seleniumbase/SeleniumBase/blob/master/.github/workflows/python-package.yml already exists to help guide you.)**
2424

25-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_9.png "GitHub Actions/Workflows")
25+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_9.png "GitHub Actions")
2626

2727
### Step 3. Commit your changes to GitHub.
2828

29-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_4.png "GitHub Actions/Workflows")
29+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_4.png "GitHub Actions")
3030

3131
----------
3232

3333
### Step 4. Your tests will now run on every pull request and on every commit to the ``master`` branch.
3434

3535
* **(See https://github.com/seleniumbase/SeleniumBase/actions for the SeleniumBase example.)**
3636

37-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_5.png "GitHub Actions/Workflows")
37+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_5.png "GitHub Actions")
3838

3939
* **(You can click inside each build for more details.)**
4040

41-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_6.png "GitHub Actions/Workflows")
41+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_6.png "GitHub Actions")
4242

4343
* **(You can also see the specific steps being performed by each command.)**
4444

45-
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_7.png "GitHub Actions/Workflows")
45+
![](https://seleniumbase.io/cdn/img/gha/github_workflows_7.png "GitHub Actions")
4646

4747
* **(You'll notice that web browsers such as Chrome and Firefox get installed for tests to use. SeleniumBase uses pytest for running tests while using Selenium to interact with web browsers.)**
4848

4949
----------
5050

51-
### Congratulations! You now know how to create and run browser tests with GitHub Actions/Workflows!
51+
### Congratulations! You now know how to create and run browser tests with GitHub Actions!
5252

5353
### **Study [SeleniumBase](https://github.com/seleniumbase/SeleniumBase) to learn more!**

0 commit comments

Comments
 (0)