|
6 | 6 | <link rel="icon" href="https://seleniumbase.io/img/logo6.png" />
|
7 | 7 |
|
8 | 8 | <p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
|
9 |
| -<img src="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" alt="SeleniumBase" title="SeleniumBase" width="420" /></a></p> |
| 9 | +<img src="https://seleniumbase.io/img/sb_logo_10.png" alt="SeleniumBase" title="SeleniumBase" width="304" /></a></p> |
| 10 | +<p align="center"> |
| 11 | +<b>Everything you need to test websites.</b> |
| 12 | +</p> |
10 | 13 |
|
11 | 14 | <!-- View on GitHub -->
|
12 | 15 | <p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/releases">
|
13 | 16 | <img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=2277EE" alt="Latest Release on GitHub" /></a> <a href="https://pypi.python.org/pypi/seleniumbase">
|
14 |
| -<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=22AAEE" alt="Latest Release on PyPI" /></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://github.com/seleniumbase/SeleniumBase/actions"> |
15 |
| -<img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase"> |
16 |
| -<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></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> <a href="http://pepy.tech/count/seleniumbase"> <img src="http://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a> <a href="https://twitter.com/SeleniumBase"> |
17 |
| -<img src="https://img.shields.io/twitter/follow/seleniumbase.svg?style=flat-rounded&logo=twitter&label=followers" alt="SeleniumBase Twitter followers" /></a> <a href="https://seleniumbase.io"> |
| 17 | +<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=22AAEE" alt="Latest Release on PyPI" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions"> |
| 18 | +<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"> |
| 19 | +<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></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> <a href="https://seleniumbase.io"> |
18 | 20 | <img src="https://img.shields.io/badge/docs-%20seleniumbase.io-22BBAA.svg" alt="SeleniumBase.io Docs" /></a></p>
|
19 | 21 |
|
20 |
| -<p><b>SeleniumBase</b>: A fast & reliable web automation framework for end-to-end testing with <a href="https://www.python.org/">Python</a>, <a href="https://docs.pytest.org/en/latest/index.html">pytest</a> and <a href="https://www.w3.org/TR/webdriver2/#endpoints">WebDriver</a>. Includes tools for reporting, visual testing, <a href="https://en.wikipedia.org/wiki/Robotic_process_automation">RPA</a>, and more.</p> |
| 22 | +<p> |
| 23 | +SeleniumBase is a Python framework for web automation, end-to-end testing, and more. |
| 24 | +Tests are run with "pytest". Browsers are controlled by WebDriver. |
| 25 | +</p> |
21 | 26 |
|
22 | 27 | <p align="center">
|
23 | 28 | <a href="#python_installation">🚀 Start</a> |
|
24 | 29 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🗂️ Features</a> |
|
25 | 30 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">🖥️ CLI</a> |
|
26 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">👨🏫 Examples</a> |
| 31 | +<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">👨🏫 Examples</a> | |
| 32 | +<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> | |
| 33 | +<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> | |
| 34 | +<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🗄️ PkgManager</a> |
27 | 35 | <br />
|
28 | 36 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📗 API</a> |
|
29 | 37 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Reports</a> |
|
| 38 | +<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">💻 Scripts</a> | |
30 | 39 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">📱 Mobile</a> |
|
| 40 | +<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">🔡 Syntax Formats</a> | |
| 41 | +<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 GridHub</a> | |
31 | 42 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md">⏺️ Recorder</a>
|
32 | 43 | <br />
|
33 | 44 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI</a> |
|
34 | 45 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/translations.md">🌏 Translate</a> |
|
35 | 46 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🗺️ Tours</a> |
|
36 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">🖼️ VisualTest</a> |
37 |
| -<br /> |
38 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">💻 CMD Scripts</a> | |
39 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a> | |
40 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">🔠 SyntaxFormats</a> |
41 |
| -<br /> |
42 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> | |
43 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> | |
44 |
| -<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🗄️ PkgManager</a> |
45 |
| -<br /> |
| 47 | +<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">🖼️ VisualTest</a> | |
46 | 48 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/ReadMe.md">📑 Presenter</a> |
|
47 | 49 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">📈 ChartMaker</a> |
|
48 | 50 | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🛂 MasterQA</a>
|
49 | 51 | </p>
|
50 | 52 |
|
51 |
| -✅ Has a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for writing UI tests.<br /> |
| 53 | +✅ Has a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for Web-UI testing.<br /> |
52 | 54 | ✅ Expands pytest [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).<br />
|
53 |
| -✅ Includes tools for [logging and reports](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).<br /> |
| 55 | +✅ Includes tools for [dashboards & reports](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).<br /> |
| 56 | +✅ Includes [scripts](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md) for driver management.<br /> |
54 | 57 |
|
55 | 58 | --------
|
56 | 59 |
|
57 |
| -<p align="center">(Below: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py">test_swag_labs.py</a> using Demo Mode.)</p> |
| 60 | +<p align="center">(Example: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py">test_swag_labs.py</a> in Demo Mode.)</p> |
58 | 61 |
|
59 | 62 | ```bash
|
60 | 63 | pytest test_swag_labs.py --demo
|
61 | 64 | ```
|
62 | 65 |
|
63 | 66 | <p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py"><img src="https://seleniumbase.io/cdn/gif/swag_demo_2.gif" alt="SeleniumBase Demo Mode" title="SeleniumBase Demo Mode" /></a></p>
|
64 | 67 |
|
65 |
| --------- |
66 |
| - |
67 | 68 | <a id="python_installation"></a>
|
68 |
| -<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Python Setup: 🐍</h2> |
| 69 | +<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Python Setup:</h2> |
69 | 70 |
|
70 | 71 | 🔵 Add **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)** to your System PATH.
|
71 | 72 |
|
72 | 73 | 🔵 Create a **[Python virtual environment](https://seleniumbase.io/help_docs/virtualenv_instructions/)**.
|
73 | 74 |
|
74 | 75 | <a id="install_seleniumbase"></a>
|
75 |
| -<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Install SeleniumBase: 🚀</h2> |
| 76 | +<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Install SeleniumBase:</h2> |
76 | 77 |
|
77 |
| -🔵 You can install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase): |
| 78 | +🔵 You can install ``seleniumbase`` from [GitHub](https://github.com/seleniumbase/SeleniumBase): |
78 | 79 |
|
79 | 80 | ```bash
|
80 |
| -pip install seleniumbase |
| 81 | +git clone https://github.com/seleniumbase/SeleniumBase.git |
| 82 | +cd SeleniumBase/ |
| 83 | +pip install . # Normal installation |
| 84 | +pip install -e . # Editable install |
81 | 85 | ```
|
82 | 86 |
|
83 |
| -> (Add ``--upgrade`` OR ``-U`` to upgrade an installation.) |
84 |
| -> (Add ``--force-reinstall`` to upgrade dependencies.) |
85 |
| -> (Use ``pip3`` if multiple versions of Python are installed.) |
| 87 | +> (When using a virtual env, the Editable install is faster.) |
86 | 88 |
|
87 |
| -🔵 You can also install ``seleniumbase`` from a [GitHub](https://github.com/seleniumbase/SeleniumBase) clone: |
| 89 | +🔵 You can also install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase): |
88 | 90 |
|
89 | 91 | ```bash
|
90 |
| -git clone https://github.com/seleniumbase/SeleniumBase.git |
91 |
| -cd SeleniumBase/ |
92 |
| -pip install . # Normal installation |
93 |
| -pip install -e . # Editable install |
| 92 | +pip install seleniumbase |
94 | 93 | ```
|
95 | 94 |
|
| 95 | +> (Add ``--upgrade`` OR ``-U`` to upgrade an installation.) |
| 96 | +> (Add ``--force-reinstall`` to upgrade dependencies.) |
| 97 | +> (Use ``pip3`` if multiple versions of Python are installed.) |
| 98 | +
|
96 | 99 | 🔵 Type ``seleniumbase`` or ``sbase`` to verify that SeleniumBase was installed successfully:
|
97 | 100 |
|
98 | 101 | ```bash
|
@@ -164,14 +167,14 @@ cd ui_tests/
|
164 | 167 | ui_tests/
|
165 | 168 | ├── __init__.py
|
166 | 169 | ├── boilerplates/
|
167 |
| -│ ├── __init__.py |
168 |
| -│ ├── base_test_case.py |
169 |
| -│ ├── boilerplate_test.py |
170 |
| -│ ├── page_objects.py |
171 |
| -│ └── samples/ |
172 |
| -│ ├── __init__.py |
173 |
| -│ ├── google_objects.py |
174 |
| -│ └── google_test.py |
| 170 | +│ ├── __init__.py |
| 171 | +│ ├── base_test_case.py |
| 172 | +│ ├── boilerplate_test.py |
| 173 | +│ ├── page_objects.py |
| 174 | +│ └── samples/ |
| 175 | +│ ├── __init__.py |
| 176 | +│ ├── google_objects.py |
| 177 | +│ └── google_test.py |
175 | 178 | ├── my_first_test.py
|
176 | 179 | ├── parameterized_test.py
|
177 | 180 | ├── pytest.ini
|
@@ -301,7 +304,7 @@ nosetests [FILE_NAME.py]:[CLASS_NAME].[METHOD_NAME]
|
301 | 304 |
|
302 | 305 |
|
303 | 306 | <a id="detailed_instructions"></a>
|
304 |
| -<img src="https://seleniumbase.io/img/sb_logo_10.png" title="SeleniumBase" width="290"> |
| 307 | +<img src="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" title="SeleniumBase" width="300"> |
305 | 308 |
|
306 | 309 | <h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Detailed Instructions:</h2>
|
307 | 310 |
|
@@ -925,6 +928,9 @@ pytest --reruns 5 --reruns-delay 1
|
925 | 928 | <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/tested%20with-SeleniumBase-04C38E.svg" alt="Tested with SeleniumBase" /></a> <a href="https://seleniumbase.io">
|
926 | 929 | <img src="https://img.shields.io/badge/docs-%20%20SeleniumBase.io-11BBDD.svg" alt="SeleniumBase.io Docs" /></a></div>
|
927 | 930 |
|
| 931 | +<div><a href="http://pepy.tech/count/seleniumbase"> <img src="http://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a> <a href="https://twitter.com/SeleniumBase"> |
| 932 | +<img src="https://img.shields.io/twitter/follow/seleniumbase.svg?style=flat-rounded&logo=twitter&label=followers" alt="SeleniumBase Twitter followers" /></a></div> |
| 933 | +
|
928 | 934 | <p><div><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="56" /></a></span>
|
929 | 935 | <span><a href="https://gitter.im/seleniumbase/SeleniumBase"><img src="https://seleniumbase.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="44" /></a></span>
|
930 | 936 | <span><a href="https://twitter.com/seleniumbase"><img src="https://seleniumbase.io/img/social/share_twitter.svg" title="SeleniumBase on Twitter" alt="SeleniumBase on Twitter" width="60" /></a></span>
|
|
0 commit comments