Update the docs
This commit is contained in:
Michael Mintz
parent
37ddaffc85
commit
16b1e4a1bb
83
README.md
83
README.md
|
|
@ -58,57 +58,88 @@ Tests are run with <code><b>pytest</b></code>. Browsers are controlled by WebDri
|
|||
<p align="center"><img src="https://cdn2.hubspot.net/hubfs/100006/images/swag_labs_gif.gif" alt="SeleniumBase" title="SeleniumBase" /></p>
|
||||
|
||||
<a id="python_installation"></a>
|
||||
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Get Started:</h2>
|
||||
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Start 🚀:</h2>
|
||||
|
||||
* Requires **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)**
|
||||
* [<img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=22AAEE" alt="Python:2.7|3.5|3.6|3.7|3.8|3.9" />](https://www.python.org/downloads/)
|
||||
* A [Python virtual env](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) is recommended. <i><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md">See shortcut</a>.</i>
|
||||
* Get **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)**
|
||||
|
||||
Upgrade **[pip](https://pypi.org/project/pip/)** to prevent warnings:
|
||||
Upgrade <b>[pip](https://pypi.org/project/pip/)</b> and create a [Python virtual environment](https://seleniumbase.io/help_docs/virtualenv_instructions/):
|
||||
|
||||
* macOS/Linux: ``python3 -m pip install -U pip``
|
||||
* Windows(Cmd): ``py -m pip install -U pip``
|
||||
* macOS/Linux:
|
||||
|
||||
```bash
|
||||
python3 -m pip install -U pip
|
||||
python3 -m venv sbase_env
|
||||
source sbase_env/bin/activate
|
||||
```
|
||||
|
||||
* Windows(Cmd):
|
||||
|
||||
```bash
|
||||
py -m pip install -U pip
|
||||
py -m venv sbase_env
|
||||
call sbase_env\\Scripts\\activate
|
||||
```
|
||||
|
||||
<a id="install_seleniumbase"></a>
|
||||
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Install SeleniumBase:</h2>
|
||||
|
||||
You can install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase):
|
||||
|
||||
```bash
|
||||
pip install seleniumbase
|
||||
```
|
||||
|
||||
* Add ``--upgrade`` OR ``-U`` to upgrade an installation.
|
||||
* Add ``--force-reinstall`` to also upgrade dependencies.
|
||||
|
||||
You can also install SeleniumBase from a [GitHub](https://github.com/seleniumbase/SeleniumBase) clone:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/seleniumbase/SeleniumBase.git
|
||||
cd SeleniumBase/
|
||||
pip install .
|
||||
```
|
||||
|
||||
* You can also install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase).
|
||||
```bash
|
||||
pip install seleniumbase
|
||||
```
|
||||
* Add ``--upgrade`` OR ``-U`` to upgrade an installation.
|
||||
* Add ``--force-reinstall`` to also upgrade dependencies.
|
||||
|
||||
<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Download a webdriver:</h3>
|
||||
|
||||
SeleniumBase can download a webdriver to the [seleniumbase/drivers](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/drivers) folder with the ``install`` command:
|
||||
SeleniumBase can download webdrivers to the [seleniumbase/drivers](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/drivers) folder with the ``install`` command:
|
||||
```bash
|
||||
seleniumbase install chromedriver
|
||||
sbase install chromedriver
|
||||
```
|
||||
* You need a different webdriver for each web browser you want to run automation on: ``chromedriver`` for Chrome, ``edgedriver`` for Edge, ``geckodriver`` for Firefox, ``operadriver`` for Opera, and ``iedriver`` for Internet Explorer.
|
||||
* You need a different webdriver for each browser: ``chromedriver`` for Chrome, ``edgedriver`` for Edge, ``geckodriver`` for Firefox, and ``operadriver`` for Opera.
|
||||
* If you have the latest version of Chrome installed, get the latest chromedriver (<i>otherwise it defaults to chromedriver 2.44 for compatibility reasons</i>):
|
||||
```bash
|
||||
seleniumbase install chromedriver latest
|
||||
sbase install chromedriver latest
|
||||
```
|
||||
|
||||
(See [seleniumbase.io/seleniumbase/console_scripts/ReadMe/](https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/) for more information on SeleniumBase console scripts, such as ``seleniumbase install`` and ``seleniumbase mkdir``.)
|
||||
(See [seleniumbase.io/seleniumbase/console_scripts/ReadMe/](https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/) for more information on SeleniumBase console scripts.)
|
||||
|
||||
<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Run a test on Chrome:</h3>
|
||||
<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Create and run tests:</h3>
|
||||
|
||||
* Use ``sbase mkdir DIR`` to create a folder with sample tests:
|
||||
|
||||
```bash
|
||||
cd examples/
|
||||
pytest my_first_test.py
|
||||
sbase mkdir ui_tests
|
||||
cd ui_tests/
|
||||
```
|
||||
|
||||
* Now run a sample test with ``pytest``:
|
||||
|
||||
```bash
|
||||
pytest test_demo_site.py
|
||||
```
|
||||
|
||||
* Chrome is the default browser if not specified with ``--browser=BROWSER``.
|
||||
* 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``.
|
||||
|
||||
<b>If you've cloned SeleniumBase from GitHub, you can also run tests from the [SeleniumBase/examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder:</b>
|
||||
|
||||
```bash
|
||||
cd examples/
|
||||
pytest my_first_test.py
|
||||
pytest test_swag_labs.py
|
||||
```
|
||||
|
||||
<b>Run [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) in Demo Mode:</b>
|
||||
|
||||
```bash
|
||||
|
|
@ -193,7 +224,7 @@ element.send_keys("dogs")
|
|||
element.submit()
|
||||
```
|
||||
|
||||
As you can see, the old WebDriver way is very bad!
|
||||
As you can see, the old WebDriver way is not efficient!
|
||||
Use SeleniumBase to make testing much easier!
|
||||
(You can still use ``self.driver`` in your code.)
|
||||
|
||||
|
|
@ -380,12 +411,12 @@ Now inside your tests, you can use ``self.data`` to access that.
|
|||
|
||||
For running tests outside of the SeleniumBase repo with **Pytest**, you'll want a copy of **[pytest.ini](https://github.com/seleniumbase/SeleniumBase/blob/master/pytest.ini)** on the root folder. For running tests outside of the SeleniumBase repo with **Nosetests**, you'll want a copy of **[setup.cfg](https://github.com/seleniumbase/SeleniumBase/blob/master/setup.cfg)** on the root folder. (Subfolders should include a blank ``__init__.py`` file.) These files specify default configuration details for tests. (For nosetest runs, you can also specify a .cfg file by using ``--config``. Example ``nosetests [MY_TEST].py --config=[MY_CONFIG].cfg``)
|
||||
|
||||
As a shortcut, you'll be able to run ``seleniumbase mkdir [DIRECTORY_NAME]`` to create a new folder that already contains necessary files and some example tests that you can run. Example:
|
||||
As a shortcut, you'll be able to run ``sbase mkdir [DIRECTORY]`` to create a new folder that already contains necessary files and some example tests that you can run.
|
||||
|
||||
```bash
|
||||
seleniumbase mkdir ui_tests
|
||||
sbase mkdir ui_tests
|
||||
cd ui_tests/
|
||||
pytest my_first_test.py
|
||||
pytest test_demo_site.py
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,9 @@
|
|||
|
||||
Examples can be found in [<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/translations">SeleniumBase/examples/translations</a>].
|
||||
|
||||
Multi-language tests are run with **pytest** like any other test. Every test method has a one-to-one mapping to every other supported language.<br /><i>Examples:</i>
|
||||
Multi-language tests are run with **pytest** like any other test. Every test method has a one-to-one mapping to every other supported language. <i>Example:</i>
|
||||
```
|
||||
self.开启网址(URL) = self.open(URL)
|
||||
self.нажмите(CSS) = self.click(CSS)
|
||||
self.뒤로() = self.go_back()
|
||||
self.open(URL) <=> self.开启网址(URL)
|
||||
```
|
||||
|
||||
<a id="translation_api"></a>
|
||||
|
|
@ -25,7 +23,7 @@ seleniumbase translate
|
|||
|
||||
```
|
||||
* Usage:
|
||||
seleniumbase translate [SB_FILE].py [LANGUAGE] [ACTION]
|
||||
seleniumbase translate [SB_FILE.py] [LANGUAGE] [ACTION]
|
||||
|
||||
* Languages:
|
||||
``--en`` / ``--English`` | ``--zh`` / ``--Chinese``
|
||||
|
|
|
|||
|
|
@ -7,11 +7,9 @@
|
|||
|
||||
Examples can be found in [<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/translations">SeleniumBase/examples/translations</a>].
|
||||
|
||||
Multi-language tests are run with **pytest** like any other test. Every test method has a one-to-one mapping to every other supported language.<br /><i>Examples:</i>
|
||||
Multi-language tests are run with **pytest** like any other test. Every test method has a one-to-one mapping to every other supported language. <i>Example:</i>
|
||||
```
|
||||
self.开启网址(URL) = self.open(URL)
|
||||
self.нажмите(CSS) = self.click(CSS)
|
||||
self.뒤로() = self.go_back()
|
||||
self.open(URL) <=> self.开启网址(URL)
|
||||
```
|
||||
|
||||
<a id="translation_api"></a>
|
||||
|
|
@ -25,7 +23,7 @@ seleniumbase translate
|
|||
|
||||
```
|
||||
* Usage:
|
||||
seleniumbase translate [SB_FILE].py [LANGUAGE] [ACTION]
|
||||
seleniumbase translate [SB_FILE.py] [LANGUAGE] [ACTION]
|
||||
|
||||
* Languages:
|
||||
``--en`` / ``--English`` | ``--zh`` / ``--Chinese``
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Virtual Environment Tutorial</h2>
|
||||
|
||||
### Step 1: Install VirtualEnv and VirtualEnvWrapper:
|
||||
### Step 0: Install VirtualEnvWrapper (<i>optional</i>):
|
||||
|
||||
* ``virtualenvwrapper`` can make it easier to work with [Python virtual environments](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) by giving you the ``mkvirtualenv`` command.
|
||||
|
||||
### macOS / Linux:
|
||||
|
||||
(*Shortcut*: Run "``source virtualenv_install.sh``" from the top-level SeleniumBase folder to perform the following steps.)
|
||||
|
||||
```bash
|
||||
python3 -m pip install pip wheel --force-reinstall
|
||||
python3 -m pip install virtualenvwrapper --force-reinstall
|
||||
export WORKON_HOME=$HOME/.virtualenvs
|
||||
source `which virtualenvwrapper.sh`
|
||||
|
|
@ -17,43 +18,45 @@ If you add ``source `which virtualenvwrapper.sh` `` to your local bash file (``~
|
|||
|
||||
### Windows:
|
||||
|
||||
(*Shortcut*: Run "``virtualenv_install.bat``" from the top-level SeleniumBase folder to perform the following steps.)
|
||||
(*Shortcut*: Run "``win_virtualenv.bat``" from the top-level SeleniumBase folder to perform the following steps.)
|
||||
|
||||
```bash
|
||||
py -m pip install pip wheel --force-reinstall --user
|
||||
py -m pip install virtualenvwrapper-win --force-reinstall --user
|
||||
```
|
||||
|
||||
### Step 2: Create a virtual environment:
|
||||
### Step 1: Create a virtual environment:
|
||||
|
||||
### macOS / Linux:
|
||||
|
||||
* Using ``mkvirtualenv`` (any version of Python):
|
||||
```bash
|
||||
mkvirtualenv sbase_env
|
||||
```
|
||||
(If you have multiple versions of Python installed on your machine, and you want your virtual environment to use a specific Python version, add ``--python=PATH_TO_PYTHON_EXE`` with the Python executable to use.)
|
||||
* (Python 3) ``python3 -m venv ENV``:
|
||||
|
||||
* (Python 3) Using ``python3 -m venv``:
|
||||
```bash
|
||||
python3 -m venv sbase_env
|
||||
source sbase_env/bin/activate
|
||||
```
|
||||
|
||||
### Windows:
|
||||
* (Python 2, 3) ``mkvirtualenv ENV``:
|
||||
|
||||
* Using ``mkvirtualenv`` (any version of Python):
|
||||
```bash
|
||||
mkvirtualenv sbase_env
|
||||
```
|
||||
(If you have multiple versions of Python installed on your machine, and you want your virtual environment to use a specific Python version, add ``--python=PATH_TO_PYTHON_EXE`` with the Python executable to use.)
|
||||
|
||||
* (Python 3) Using ``py -m venv``:
|
||||
### Windows:
|
||||
|
||||
* (Python 3) ``py -m venv ENV``:
|
||||
|
||||
```bash
|
||||
py -m venv sbase_env
|
||||
call sbase_env\\Scripts\\activate
|
||||
```
|
||||
|
||||
* (Python 2, 3) ``mkvirtualenv ENV``:
|
||||
```bash
|
||||
mkvirtualenv sbase_env
|
||||
```
|
||||
(If you have multiple versions of Python installed on your machine, and you want your virtual environment to use a specific Python version, add ``--python=PATH_TO_PYTHON_EXE`` with the Python executable to use.)
|
||||
|
||||
---
|
||||
|
||||
### mkvirtualenv Commands
|
||||
|
|
|
|||
Loading…
Reference in New Issue