Update documentation
This commit is contained in:
Michael Mintz
parent
fc02fd3092
commit
b945f95011
18
README.md
18
README.md
|
|
@ -2,9 +2,9 @@
|
|||
|
||||
[](https://pypi.python.org/pypi/seleniumbase) [](https://travis-ci.org/seleniumbase/SeleniumBase) [](https://github.com/seleniumbase/SeleniumBase/stargazers) [](https://docs.python.org/2/) [](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [](https://gitter.im/seleniumbase/SeleniumBase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
**Automation Platform for Testing and Business**
|
||||
**Web Automation Platform for Testing and More**
|
||||
|
||||
(And the power to [speed up your manual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md))
|
||||
(And the power to [speed up manual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md))
|
||||
|
||||
|
||||
|
||||
|
|
@ -29,13 +29,17 @@ SeleniumBase makes it easy to automate tedious business tasks. (*To learn about
|
|||
|
||||
* To install ``python``, ``pip``, ``git``, and either ``virtualenv`` or ``virtualenvwrapper``, **[follow these instructions](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/requirements_installation.md)**.
|
||||
|
||||
* Download web browsers such as [Chrome](https://www.google.com/chrome/browser/desktop/index.html) (or [Chromium](https://download-chromium.appspot.com/)) and also [Firefox v46.*](https://ftp.mozilla.org/pub/firefox/releases/46.0.1/) (or [Firefox ESR](https://www.mozilla.org/en-US/firefox/organizations/)) because Firefox versions 47.0 and above are no longer compatible with normal Selenium WebDriver. (If you go with Firefox 46.*, make sure to turn off auto-updates or else you'll be back at v47+ quickly!)
|
||||
* Download web browsers such as [Chrome](https://www.google.com/chrome/browser/desktop/index.html) (or [Chromium](https://download-chromium.appspot.com/)) and [Firefox](https://www.mozilla.org/firefox/new/).
|
||||
|
||||
(NOTE: Firefox versions 47.0 and above are no longer compatible with normal Selenium WebDriver. [Get Firefox 46.*](https://ftp.mozilla.org/pub/firefox/releases/46.0.1/) instead, or you can [Get Firefox ESR](https://www.mozilla.org/en-US/firefox/organizations/). (If you go with Firefox 46.*, make sure to turn off auto-updates or else you'll be back at v47 quickly!) For more information regarding this, [read this post](http://stackoverflow.com/questions/37693106/selenium-2-53-not-working-on-firefox-47) from Stack Overflow. There's a [new version of Firefox driver](https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver) coming soon.
|
||||
* To run browser automation on Chrome, you'll need to download **[Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads)** and put it on your System **[PATH](http://java.com/en/download/help/path.xml)**.
|
||||
|
||||
* If you want to run automation on browsers other than Firefox, you'll need to download [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads), [PhantomJS](http://phantomjs.org/download.html), [Edge Driver (Microsoft WebDriver)](https://www.microsoft.com/en-us/download/details.aspx?id=48212), and/or [Safari Driver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/using_safari_driver.md) separately. (Firefox drivers come with Selenium by default.)
|
||||
* For Firefox, get [Geckodriver](https://github.com/mozilla/geckodriver/releases) on your System Path.
|
||||
|
||||
* For everything you download (such as ``pip`` and ``Chromedriver``) make sure those files get on your system [PATH](http://java.com/en/download/help/path.xml). (``Environmental Variables`` on a Windows machine)
|
||||
* For Microsoft Edge, get [Edge Driver (Microsoft WebDriver)](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/) on your System Path.
|
||||
|
||||
* For Safari, get [Safari Driver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/using_safari_driver.md) on your System Path.
|
||||
|
||||
* For PhantomJS headless browser automation, get [PhantomJS](http://phantomjs.org/download.html) on your System Path.
|
||||
|
||||
Mac:
|
||||
|
||||
|
|
@ -124,7 +128,7 @@ nosetests my_first_test.py --with-selenium --browser=firefox -s
|
|||
nosetests my_first_test.py --with-selenium --browser=phantomjs -s
|
||||
```
|
||||
|
||||
After the test completes, in the console output you'll see a dot (``.``) on a new line, representing a passing test. (On test failures you'll see an ``F`` instead, and on test errors you'll see an ``E``). It looks more like a moving progress bar when you're running a ton of unit tests side by side. This is part of nosetests. After all tests complete (in this case there is only one), you'll see the "``Ran 1 test in ...``" line, followed by an "``OK``" if all nosetests passed. The ``--with-selenium`` option is required for running GUI tests. If no browser is specified, Firefox will become the default. The ``-s`` option is optional, and that makes sure that any standard output is printed immediately on the command line when tests have print statements in them, which makes debugging much easier.
|
||||
After the test completes, in the console output you'll see a dot (``.``) on a new line, representing a passing test. (On test failures you'll see an ``F`` instead, and on test errors you'll see an ``E``). It looks more like a moving progress bar when you're running a ton of unit tests side by side. This is part of nosetests. After all tests complete (in this case there is only one), you'll see the "``Ran 1 test in ...``" line, followed by an "``OK``" if all nosetests passed. The ``--with-selenium`` option is required for running GUI tests. If no browser is specified, Chrome will become the default. The ``-s`` option is optional, and that makes sure that any standard output is printed immediately on the command line when tests have print statements in them, which makes debugging much easier.
|
||||
|
||||
NOTE: The following two lines of code can be simplified...
|
||||
``` python
|
||||
|
|
|
|||
|
|
@ -3,19 +3,27 @@
|
|||
|
||||
### [Python 2.7](https://www.python.org/downloads/)
|
||||
|
||||
If you're a MAC user, that should already come preinstalled on your machine. Although Python 3 exists, you'll want Python 2 (both of these major versions are being improved in parallel). Python 2.7.10 is the one I've been using on my Mac.
|
||||
If you're a MAC user, that should already come preinstalled on your machine. Although Python 3 exists, you'll want Python 2 (both of these major versions are being improved in parallel). Python 2.7.13 is the one I've been using on my Mac.
|
||||
|
||||
If you're a WINDOWS user, [download the latest 2.* version from here](https://www.python.org/downloads/release/python-2713/).
|
||||
|
||||
If you're a WINDOWS user, [download the latest 2.* version from here](https://www.python.org/downloads/release/python-2710/).
|
||||
|
||||
### [Pip](https://en.wikipedia.org/wiki/Pip_%28package_manager%29)
|
||||
|
||||
If "pip" did not come with your Python installation, you can [GET PIP HERE](https://pip.pypa.io/en/latest/installing/).
|
||||
|
||||
On a MAC, you can also install pip easily with the following command:
|
||||
On a MAC, run the following command:
|
||||
```bash
|
||||
sudo easy_install pip
|
||||
```
|
||||
Then make sure it's on your path.
|
||||
|
||||
On WINDOWS, run the following command:
|
||||
```bash
|
||||
python -m pip install -U pip setuptools
|
||||
```
|
||||
|
||||
If you're having any trouble with that, you can [GET PIP HERE](https://pip.pypa.io/en/latest/installing/).
|
||||
|
||||
When done, make sure pip is on your path. ($PATH on Mac/Linux. System Environment Variables on WINDOWS.)
|
||||
|
||||
|
||||
### [Homebrew](http://brew.sh/) (MAC-ONLY) (OPTIONAL)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue