Skip to content

Commit c5a6390

Browse files
committed
Update the docs
1 parent 116f4b1 commit c5a6390

File tree

2 files changed

+29
-20
lines changed

2 files changed

+29
-20
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,25 @@ pytest my_first_test.py --demo_mode
1212

1313
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Quick Start:
1414

15-
(<i>Requires **[Python/Pip](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md)** [<img src="https://img.shields.io/badge/python-2.7,_3.5,_3.6,_3.7-22AADD.svg" alt="Python versions" />](https://www.python.org/downloads/). Optionally, you may want to use a [Python virtual environment](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md) to isolate Python dependencies between projects.</i>)
15+
You'll need **[Python](https://www.python.org/downloads/)** [<img src="https://img.shields.io/badge/python-2.7,_3.5,_3.6,_3.7-22AADD.svg" alt="Python versions" />](https://www.python.org/downloads/)
1616

17-
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Git clone and install SeleniumBase:
17+
Optionally, you may want a [Python virtual environment](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md) to isolate Python dependencies between projects.
18+
19+
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install/upgrade ``pip``:
20+
21+
With Python installed and on your System PATH, you can get the latest ``pip`` with:
22+
```
23+
python -m easy_install -U pip
24+
```
25+
26+
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install ``seleniumbase``: [<img src="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg" alt="pypi" />](https://pypi.python.org/pypi/seleniumbase)
27+
```
28+
pip install seleniumbase
29+
```
30+
* Add ``--upgrade`` to upgrade an existing installation.
31+
* Add ``--force-reinstall`` for a clean install.
32+
33+
You can also install SeleniumBase from a ``git clone``:
1834
```
1935
git clone https://github.com/seleniumbase/SeleniumBase.git
2036
cd SeleniumBase
@@ -23,12 +39,6 @@ python setup.py develop
2339
```
2440
* ("``pip install -e .``" also works from the top-level SeleniumBase folder.)
2541

26-
SeleniumBase can also be installed from [PyPI](https://pypi.python.org/pypi/seleniumbase): [<img src="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg" alt="pypi" />](https://pypi.python.org/pypi/seleniumbase)
27-
```
28-
pip install seleniumbase
29-
```
30-
* (Add ``--upgrade`` to get the latest packages. Add ``--force-reinstall`` with ``--no-cache-dir`` to force a clean installation.)
31-
3242
You can also install a specific GitHub branch of SeleniumBase:
3343
```
3444
pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
@@ -68,8 +78,8 @@ self.update_text("textarea", "text")
6878
```
6979
(<i>You can still use ``self.driver`` in your code.</i>)
7080

71-
#### **Run tests with Pytest or Nose in any browser:**<br />
72-
(<i>Using **Pytest** is strongly recommended</i>)
81+
#### **Run tests with ``pytest`` or ``nose`` in any browser:**<br />
82+
(<i>Using **pytest** is strongly recommended</i>)
7383
```
7484
pytest my_first_test.py --browser=chrome
7585

help_docs/install_python_pip_git.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,21 @@ You can [download Git from here](http://git-scm.com/downloads).
88

99
(You can also download SeleniumBase from GitHub without using git-related commands.)
1010

11-
### [Python 2.7 or 3.x](https://www.python.org/downloads/)
11+
### [Python 2.7 or 3.x](https://www.python.org)
1212

13-
#### macOS:
14-
15-
Python should already come preinstalled. You can use both Python 2.7 or Python 3.6+ with SeleniumBase. If you have [Homebrew](https://brew.sh/) installed, you can use: ``brew install python3`` to install Python 3. Or you can just get everything from [https://www.python.org/downloads/](https://www.python.org/downloads/).
16-
17-
The official docs.python-guide.org instructions here: [Installing Python 2 on Mac OS X](https://docs.python-guide.org/starting/install/osx/) and [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/#install3-osx). (NOTE: Apple has rebranded OS X as macOS but this has not been reflected in the official docs.python-guide.org instructions yet.)
18-
19-
#### Windows:
20-
21-
You can [download Python 2.7 from here](https://www.python.org/downloads/release/python-2713/) OR [download Python 3.6.6 from here](https://www.python.org/downloads/release/python-366/).
13+
You can download Python from [https://www.python.org/downloads/](https://www.python.org/downloads/) if it's not already preinstalled on your machine.
2214

2315
### [Pip](https://en.wikipedia.org/wiki/Pip_%28package_manager%29)
2416

2517
You might already have pip and setuptools installed, but if you don't:
2618

19+
```bash
20+
python -m easy_install -U pip
21+
pip install -U setuptools
22+
```
23+
24+
If that didn't work, here are some more commands you can try:
25+
2726
On macOS / Windows / Linux, run the following command:
2827
```bash
2928
python -m ensurepip --default-pip

0 commit comments

Comments
 (0)