Skip to content

Commit 2b81816

Browse files
committed
Update the ReadMe
1 parent b62c479 commit 2b81816

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_i.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)<br />
1+
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_2h2.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)<br />
22

3-
[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg?color=2277EE" alt="SeleniumBase" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=22AAEE" alt=" " />](https://pypi.python.org/pypi/seleniumbase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/travis/seleniumbase/SeleniumBase/master.svg" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg">](https://github.com/seleniumbase/SeleniumBase/actions) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers) [<img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=DDBB24" alt="Python versions" />](https://www.python.org/downloads/)<br />
3+
[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg?color=2277EE" alt="SeleniumBase" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=22AAEE" alt=" " />](https://pypi.python.org/pypi/seleniumbase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/travis/seleniumbase/SeleniumBase/master.svg" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg">](https://github.com/seleniumbase/SeleniumBase/actions) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=777CFA" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)<br />
44

5-
A complete framework for web & mobile automation, end-to-end testing, and [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). SeleniumBase uses [pytest](https://docs.pytest.org/en/latest/index.html) for running Python scripts, while using [Selenium WebDriver](https://selenium.dev/) for controlling web browsers.
5+
A Python toolkit for easy end-to-end web testing and [site tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md) with [pytest](https://docs.pytest.org/en/latest/index.html) and [Selenium WebDriver](https://selenium.dev/).
66

77
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_gif.gif" title="SeleniumBase"><br />
88
(<i>Above: [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) from [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) running in Demo Mode, which adds JavaScript for highlighting page actions.</i>)<br />
@@ -23,30 +23,31 @@ pytest my_first_test.py --demo
2323
<a id="python_installation"></a>
2424
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Quick Start
2525

26-
(<i>Requires [Git](https://git-scm.com/) and [Python](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>)
27-
28-
#### Upgrade [pip](https://pypi.org/project/pip/) and [setuptools](https://pypi.org/project/setuptools/):
26+
* Requires **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)**
27+
* [<img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=22AAEE" alt="Python versions" />](https://www.python.org/downloads/)
28+
* A [Python virtual env](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) is recommended. <i>[See shortcut](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).</i>
29+
* Upgrade **[pip](https://pypi.org/project/pip/)** to prevent warnings:
2930
```bash
30-
python -m pip install -U pip setuptools
31+
python -m pip install -U pip
3132
```
3233

3334
<a id="install_seleniumbase"></a>
3435
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install ``seleniumbase``:
3536
```bash
36-
pip install seleniumbase
37-
```
38-
* Add ``--upgrade`` OR ``-U`` to upgrade an installation.
39-
* Add ``--force-reinstall`` for a clean install.
40-
41-
You can also install seleniumbase from a ``git clone``:
42-
```bash
4337
git clone https://github.com/seleniumbase/SeleniumBase.git
4438
cd SeleniumBase/
4539
pip install -r requirements.txt
4640
python setup.py install
4741
```
4842
If multiple versions of Python are installed, be specific (E.g. use ``python3`` instead of ``python``).
4943

44+
* You can also install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase):
45+
```bash
46+
pip install seleniumbase
47+
```
48+
* Add ``--upgrade`` OR ``-U`` to upgrade an installation.
49+
* Add ``--force-reinstall`` for a clean install.
50+
5051
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Download a webdriver:
5152

5253
SeleniumBase can download a webdriver to the [seleniumbase/drivers](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/drivers) folder with the ``install`` command:
@@ -67,9 +68,11 @@ pytest my_first_test.py
6768
* Chrome is the default browser if not specified with ``--browser=BROWSER``.
6869
* On Linux ``--headless`` is the default behavior (running with no GUI). You can also run in headless mode on any OS. If your Linux machine has a GUI and you want to see the web browser as tests run, add ``--headed`` or ``--gui``.
6970

70-
**Check out [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) to see what a simple test looks like:**
71-
* <i>By default, [CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp) are used for finding page elements.</i>
72-
* Here are some common SeleniumBase methods you might find in tests:
71+
**Check out [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) to see what a script looks like:**
72+
<img src="https://cdn2.hubspot.net/hubfs/100006/my_first_test_py_4.png" title="My First SeleniumBase Test"><br />
73+
* By default, **[CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp)** are used for finding page elements.
74+
* If you're new to CSS Selectors, games like [Flukeout](http://flukeout.github.io/) can help you learn.
75+
* Here are some common ``SeleniumBase`` methods you might find in tests:
7376
```python
7477
self.open(URL) # Navigate to the web page
7578
self.click(SELECTOR) # Click a page element
@@ -654,8 +657,8 @@ Additionally, you can use the ``@retry_on_exception()`` decorator to specificall
654657

655658
**If you see something, say something!**<br />[<img src="https://img.shields.io/github/issues-closed-raw/seleniumbase/SeleniumBase.svg?color=22BB88" alt=" " />](https://github.com/seleniumbase/SeleniumBase/issues?q=is%3Aissue+is%3Aclosed) [<img src="https://img.shields.io/github/issues-pr-closed/seleniumbase/SeleniumBase.svg?logo=github&logoColor=white&color=22BB99">](https://github.com/seleniumbase/SeleniumBase/pulls?q=is%3Apr+is%3Aclosed)
656659

660+
**If you like us, give us a star!**<br />[<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=777CFA" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)
661+
657662
[https://github.com/mdmintz](https://github.com/mdmintz)<br />
658663

659664
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_media_logo_c.png" title="SeleniumBase" height="100">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/repo-size/seleniumbase/seleniumbase.svg" alt="Size" />](https://github.com/seleniumbase/SeleniumBase/releases)
660-
661-
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_i.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)

0 commit comments

Comments
 (0)