Skip to content

Commit 111a68a

Browse files
committed
Update the ReadMe
1 parent 00b99d3 commit 111a68a

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

README.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
1-
## SeleniumBase Automation Framework
1+
<img src="https://cdn2.hubspot.net/hubfs/100006/images/logo_base_4b.png" title="SeleniumBase" height="160">
22

3-
<img src="https://cdn2.hubspot.net/hubfs/100006/images/laptop_logo.png" title="SeleniumBase" height="160">
3+
## SeleniumBase &middot; [![](https://img.shields.io/pypi/v/seleniumbase.svg)](https://pypi.python.org/pypi/seleniumbase) [![Build Status](https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master)](https://travis-ci.org/seleniumbase/SeleniumBase)<br />
44

5-
[![](https://img.shields.io/pypi/v/seleniumbase.svg)](https://pypi.python.org/pypi/seleniumbase) [![Build Status](https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master)](https://travis-ci.org/seleniumbase/SeleniumBase) [![Join the chat at https://gitter.im/seleniumbase/SeleniumBase](https://badges.gitter.im/seleniumbase/SeleniumBase.svg)](https://gitter.im/seleniumbase/SeleniumBase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)<br />
5+
SeleniumBase simplifies test automation with [WebDriver](https://docs.microsoft.com/en-us/microsoft-edge/webdriver) & [Pytest](https://github.com/pytest-dev/pytest).
66

7-
SeleniumBase makes it easy to build & run [Selenium-WebDriver](https://github.com/SeleniumHQ/selenium) automation with [Pytest](https://docs.pytest.org/en/latest/).
7+
#### Quick start in a few steps: (requires [Python](https://www.python.org/downloads/))
88

9-
**Watch [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) run in [Demo Mode](#seleniumbase_demo_mode):**<br>
9+
```bash
10+
python -m pip install seleniumbase --upgrade
11+
seleniumbase install chromedriver
12+
seleniumbase mkdir browser_tests
13+
cd browser_tests
14+
pytest my_first_test.py --browser=chrome
15+
```
16+
17+
The ``seleniumbase mkdir [NAME]`` command creates a new folder with some sample tests you can run. If you wish to use a different browser, you can use ``seleniumbase install [DRIVER]`` with other drivers such as ``edgedriver`` (Microsoft Edge) or ``geckodriver`` (Firefox). Then use ``--browser=edge`` or ``--browser=firefox`` to run tests on that browser (assuming you already have that web browser installed). ``--browser=chrome`` is the default option if not specified.
18+
19+
**Slow-motion demo of [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) running:**<br>
1020
![](https://cdn2.hubspot.net/hubfs/100006/images/sb_demo.gif "SeleniumBase")<br>
1121

12-
### [**Get Started**](#seleniumbase_installation), or Learn More:
22+
There are many more examples to try out from the [SeleniumBase/examples](https://github.com/seleniumbase/SeleniumBase/blob/master/examples) directory, which you can run easily if you clone SeleniumBase.
23+
24+
For more detailed steps on getting started, see the [**Detailed Instructions**](#seleniumbase_installation) section.
25+
26+
### Learn More:
1327

1428
**No more repetitive WebDriver code:**<br />
1529
SeleniumBase automatically handles common WebDriver actions such as spinning up web browsers, waiting for page objects to load, saving screenshots during test failures, using a proxy server, and more. (<i>[Read about customizing test runs](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).</i>)
@@ -29,6 +43,8 @@ pytest my_first_test.py --browser=chrome
2943
nosetests my_test_suite.py --browser=firefox
3044
```
3145

46+
Python methods that start with ``test_`` will automatically be run when using ``pytest`` or ``nosetests`` on a Python file, (<i>or on folders containing Python files</i>).
47+
3248
**No more messy code:**<br />
3349
This long line of standard WebDriver code,
3450
```python
@@ -53,15 +69,15 @@ SeleniumBase is compatible with [Selenium Grid](https://github.com/seleniumbase/
5369
SeleniumBase makes it easy to automate tedious business tasks. (*To learn about businesses using SeleniumBase, [Click Here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/happy_customers.md).*)
5470

5571
**Extensively tested and made with love:**<br />
56-
SeleniumBase was originally built for [testing HubSpot's platform](https://product.hubspot.com/blog/the-classic-qa-team-is-obsolete) and automating business processes. In 2014, SeleniumBase was open-sourced and spun off as its own independent entity to benefit users everywhere.
72+
SeleniumBase was originally built for [testing HubSpot's platform](https://product.hubspot.com/blog/bid/88880/Automated-Integration-Testing-with-Selenium-at-HubSpot) and automating business processes. In 2014, SeleniumBase was open-sourced and spun off as its own independent entity to benefit users everywhere.
5773

58-
**Contains lots of additional features:**<br />
74+
**Plenty of features:**<br />
5975
([Read more about SeleniumBase features here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md))
6076

6177
<a id="seleniumbase_installation"></a>
62-
<br><img src="https://cdn2.hubspot.net/hubfs/100006/images/new_logo_pre6c.png" title="SeleniumBase" height="40">
78+
<br><img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo8g.png" title="SeleniumBase" height="40">
6379

64-
## Get Started:
80+
## Detailed Instructions:
6581

6682
Before installation, **[install Python](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md)** and **[install a web driver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/webdriver_installation.md)**.
6783

@@ -86,14 +102,14 @@ cd SeleniumBase
86102

87103
If you're installing SeleniumBase from a cloned copy on your machine, use:
88104
```
89-
pip install -r requirements.txt
105+
pip install -r requirements.txt --upgrade
90106
91107
python setup.py develop
92108
```
93109

94110
If you're installing SeleniumBase from the [Python Package Index](https://pypi.python.org/pypi/seleniumbase), use:
95111
```bash
96-
pip install seleniumbase
112+
pip install seleniumbase --upgrade
97113
```
98114

99115
If you're installing SeleniumBase directly from GitHub, use:
@@ -611,10 +627,10 @@ Now you can parse through the email if you're looking for specific text or want
611627

612628
**Congratulations** on learning how to use **SeleniumBase**!
613629

614-
<i>**Questions or Comments?**</i><br>
630+
<i>**Questions or Comments?**</i><br />
615631
[![Join the chat at https://gitter.im/seleniumbase/SeleniumBase](https://badges.gitter.im/seleniumbase/SeleniumBase.svg)](https://gitter.im/seleniumbase/SeleniumBase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)<br>
616632

617633
[https://github.com/mdmintz](https://github.com/mdmintz)<br>
618634
[https://www.linkedin.com/in/mdmintz](https://www.linkedin.com/in/mdmintz)<br>
619635

620-
<img src="https://cdn2.hubspot.net/hubfs/100006/images/new_logo_pre6c.png" title="SeleniumBase" height="40"> <br> <img src="https://cdn2.hubspot.net/hubfs/100006/images/logo_base_4b.png" title="SeleniumBase" height="150">
636+
<img src="https://cdn2.hubspot.net/hubfs/100006/images/new_logo_pre6c.png" title="SeleniumBase" height="40"> <br /> <img src="https://cdn2.hubspot.net/hubfs/100006/images/logo_base_4b.png" title="SeleniumBase" height="150">

0 commit comments

Comments
 (0)