Skip to content

Commit b826f56

Browse files
committed
Update the docs
1 parent 757ae86 commit b826f56

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Browser automated testing with Python done efficiently.<br />
99
[**Get Started**](#seleniumbase_installation), or Learn More:
1010

1111
**A framework for all your UI testing:**<br />
12-
SeleniumBase is a complete end-to-end testing solution for web apps. It extends Python's unittest framework by including the WebDriver APIs and adding functionality to make automation more efficient & reliable. It simplifies the process of setting up continuous integration and writing automated tests.
12+
SeleniumBase simplifies end-to-end UI testing by extending Python's unittest framework with WebDriver APIs and adding features to improve the process of creating and running automation.
1313

14-
**No more repetitive WebDriver coding:**<br />
15-
SeleniumBase automatically takes care of common WebDriver actions such as spinning up & closing web browsers, creating screenshots & logs for test failures, waiting for page objects to fully appear before acting on them, connecting to a Selenium Grid, using a proxy server, writing to a database, etc. (<i>[Read more](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/command_line.md)</i>)
14+
**No more repetitive WebDriver code:**<br />
15+
SeleniumBase automatically handles common WebDriver actions such as spinning up web browsers, waiting for page objects to load, saving screenshots during test failures, and more. (<i>[Read about the command line interface](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/command_line.md).</i>)
1616

1717
**Simple Python syntax makes coding easy:**<br />
1818
(<i>By default, [CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp) are used for finding page elements.</i>)
@@ -65,7 +65,7 @@ SeleniumBase was originally built for [testing HubSpot's platform](https://produ
6565

6666
## Get Started:
6767

68-
(Before installation, you'll need to **[install Python](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md)** and **[download Webdriver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/webdriver_installation.md)**.)
68+
(Before installation, **[install Python](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md)** and **[get WebDriver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/webdriver_installation.md)** on your system PATH.)
6969

7070

7171
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Step 1:** Clone SeleniumBase
@@ -81,29 +81,23 @@ cd SeleniumBase
8181

8282
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Step 2:** Create a Virtual Env.
8383

84-
(OPTIONAL) To learn how to create a Python virtual environment, [see the ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).<br><br><i>[python-guide.org/en/latest/dev/virtualenvs](http://docs.python-guide.org/en/latest/dev/virtualenvs/) has more details.</i>
85-
86-
If you choose not to use a Python virtual environment, add the ``--user`` flag at the end of your pip and python install commands in *Step 3*. (This can help you evade issues with requiring root access on the machine you're using.)
84+
(OPTIONAL) To learn how to create a Python virtual environment, [see this ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).
8785

8886

8987
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Step 3:** Install SeleniumBase
9088

91-
Run the following command from the top-level SeleniumBase folder:
92-
```bash
93-
pip install -e .
94-
```
95-
If you already have an older version installed, you may need to add ``--upgrade`` to the command in order to update previously-installed Python packages. If you're not using a virtual environment, you may need to add ``--user`` to the end of your command. (<i>Only needed if you see errors during installation.</i>)
96-
97-
If you want to install the requirements seperately, use:
89+
Run the following commands from the top-level SeleniumBase folder:
9890
```
9991
pip install -r requirements.txt
10092
10193
python setup.py develop
10294
```
10395

104-
(<i>If you can't install ChromeDriver or GeckoDriver, you can use `server_requirements.txt` and `server_setup.py` to run tests using the older Selenium 2.53.6 on a version of Firefox that's older than 47.</i>)
96+
If you already have an older version installed, add ``--upgrade`` to the ``pip`` command in order to update previously-installed Python packages. If you're not using a virtual environment, you may need to add ``--user`` to the end of your ``pip`` command. (<i>Do that if you see any errors during installation.</i>)
97+
98+
(<i>If you can't install ChromeDriver or GeckoDriver, use `server_requirements.txt` and `server_setup.py` to run tests using the older Selenium 2.53.6 on a version of Firefox that's older than 47.</i>)
10599

106-
To install SeleniumBase from the [Python Package Index](https://pypi.python.org/pypi/seleniumbase) use the following command. (You may need to add ``--upgrade`` if you have an older version already installed.):
100+
To install SeleniumBase from the [Python Package Index](https://pypi.python.org/pypi/seleniumbase) use the following command: (Add ``--upgrade`` and/or ``--user`` to the command as needed.)
107101
```bash
108102
pip install seleniumbase
109103
```

help_docs/virtualenv_instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,5 @@ To delete a virtual environment:
6767
```bash
6868
rmvirtualenv VIRTUAL_ENV_NAME
6969
```
70+
71+
<br><br><i>[python-guide.org/en/latest/dev/virtualenvs](http://docs.python-guide.org/en/latest/dev/virtualenvs/) has more information about Python virtual environments.</i>

0 commit comments

Comments
 (0)