test_framework
/
SeleniumBase
mirror of https://github.com/seleniumbase/SeleniumBase.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update the docs

This commit is contained in:
Michael Mintz 2018-12-27 02:14:24 -05:00
parent be60c286d9
commit a3713da79a
5 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,8 +1,8 @@
[<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) [<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)
[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the Gitter Chat" />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)<br /> [<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the Gitter Chat" />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="http://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)<br />
Reliable browser automation and testing framework that uses [Selenium-WebDriver](https://www.seleniumhq.org/) and extends [Pytest](https://docs.pytest.org/en/latest/). Reliable Browser Automation & Testing with [Selenium-WebDriver](https://www.seleniumhq.org/) and [Pytest](https://docs.pytest.org/en/latest/).
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_box2.png" title="SeleniumBase" height="32"> Quick Start ## <img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_box2.png" title="SeleniumBase" height="32"> Quick Start
@ -17,7 +17,7 @@ git clone https://github.com/seleniumbase/SeleniumBase.git
``` ```
python -m pip install -U pip setuptools python -m pip install -U pip setuptools
``` ```
* (You may need to add ``--user`` to the command if you're not inside a [Python virtual environment](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md), or use "[sudo](https://en.wikipedia.org/wiki/Sudo)" on a UNIX-based OS.) * (Depending on your user permissions, you may need to add ``--user`` to the command if you're not inside a [Python virtual environment](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md), or use "[sudo](https://en.wikipedia.org/wiki/Sudo)" on a UNIX-based OS if you're getting errors during installation.)
#### Install SeleniumBase: #### Install SeleniumBase:
``` ```
@ -33,7 +33,7 @@ python setup.py install
seleniumbase install chromedriver seleniumbase install chromedriver
``` ```
#### Run a test on chrome: #### Run a test on Chrome:
``` ```
cd examples cd examples
pytest my_first_test.py --browser=chrome pytest my_first_test.py --browser=chrome
@ -367,7 +367,7 @@ Here are some things you can do to setup a production environment for your testi
* If you're using the [SeleniumBase MySQL feature](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mysql_installation.md) to save results from tests running on a server machine, you can install [MySQL Workbench](http://dev.mysql.com/downloads/tools/workbench/) to help you read & write from your DB more easily. You'll also need to install the MySQL Python client. Depending on your system, you may need to install additional requirements for this (such as on Windows). See [Stackoverflow](https://stackoverflow.com/questions/43102442/whats-the-difference-between-mysqldb-mysqlclient-and-mysql-connector-python) for more info. * If you're using the [SeleniumBase MySQL feature](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mysql_installation.md) to save results from tests running on a server machine, you can install [MySQL Workbench](http://dev.mysql.com/downloads/tools/workbench/) to help you read & write from your DB more easily. You'll also need to install the MySQL Python client. Depending on your system, you may need to install additional requirements for this (such as on Windows). See [Stackoverflow](https://stackoverflow.com/questions/43102442/whats-the-difference-between-mysqldb-mysqlclient-and-mysql-connector-python) for more info.
``` ```
pip install mysqlclient==1.3.12 pip install mysqlclient==1.3.14
``` ```
* If you use [Slack](https://slack.com), you can easily have your Jenkins jobs display results there by using the [Jenkins Slack Plugin](https://github.com/jenkinsci/slack-plugin). Another way to send messages from your tests to Slack is by using [Slack's Incoming Webhooks API](https://api.slack.com/incoming-webhooks). * If you use [Slack](https://slack.com), you can easily have your Jenkins jobs display results there by using the [Jenkins Slack Plugin](https://github.com/jenkinsci/slack-plugin). Another way to send messages from your tests to Slack is by using [Slack's Incoming Webhooks API](https://api.slack.com/incoming-webhooks).
@ -739,5 +739,4 @@ If you see something, say something! We are very active in resolving issues. [<i
[https://github.com/mdmintz](https://github.com/mdmintz)<br /> [https://github.com/mdmintz](https://github.com/mdmintz)<br />
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g4.png" title="SeleniumBase" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> <img src="https://cdn2.hubspot.net/hubfs/100006/images/logo_base_4b.png" title="SeleniumBase" height="150"> [<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g4.png" title="SeleniumBase" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> <img src="https://cdn2.hubspot.net/hubfs/100006/images/logo_base_4b.png" title="SeleniumBase" height="150"> <br /> [<img src="http://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE)
[<img src="http://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE)

2
_config.yml
View File

@ -1,3 +1,3 @@
theme: jekyll-theme-cayman theme: jekyll-theme-cayman
title: SeleniumBase title: SeleniumBase
description: Reliable browser automation and testing framework description: Reliable Browser Automation & Testing

2
help_docs/install.md
View File

@ -17,7 +17,7 @@ If you're installing SeleniumBase directly [from GitHub](https://github.com/sele
pip install -U -e git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase pip install -U -e git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
``` ```
If you're installing SeleniumBase directly [from Anaconda Cloud](https://anaconda.org/seleniumbase/dashboard), use: If you're installing SeleniumBase directly [from Anaconda Cloud](https://anaconda.org/seleniumbase/seleniumbase), use:
```bash ```bash
pip install -U -i https://pypi.anaconda.org/seleniumbase/simple seleniumbase pip install -U -i https://pypi.anaconda.org/seleniumbase/simple seleniumbase
``` ```

4
help_docs/virtualenv_instructions.md
View File

@ -4,6 +4,8 @@
### MAC / Linux: ### MAC / Linux:
(*Shortcut*: Run "``source virtualenv_install.sh``" from the top-level SeleniumBase folder to perform the following steps.)
```bash ```bash
python -m pip install --upgrade virtualenv python -m pip install --upgrade virtualenv
python -m pip install --upgrade virtualenvwrapper python -m pip install --upgrade virtualenvwrapper
@ -15,6 +17,8 @@ If you add ``source `which virtualenvwrapper.sh` `` to your local bash file (``~
### WINDOWS: ### WINDOWS:
(*Shortcut*: Run "``virtualenv_install.bat``" from the top-level SeleniumBase folder to perform the following steps.)
```bash ```bash
python -m pip install --upgrade virtualenv python -m pip install --upgrade virtualenv
python -m pip install --upgrade virtualenvwrapper-win python -m pip install --upgrade virtualenvwrapper-win

4
setup.py
View File

@ -13,12 +13,12 @@ try:
with open(path.join(this_directory, 'README.md'), 'rb') as f: with open(path.join(this_directory, 'README.md'), 'rb') as f:
long_description = f.read().decode('utf-8') long_description = f.read().decode('utf-8')
except IOError: except IOError:
long_description = 'Reliable Browser Automation and Testing Framework' long_description = 'Reliable Browser Automation & Testing Framework'
setup( setup(
name='seleniumbase', name='seleniumbase',
version='1.17.17', version='1.17.17',
description='Reliable Browser Automation and Testing Framework', description='Reliable Browser Automation & Testing Framework',
long_description=long_description, long_description=long_description,
long_description_content_type='text/markdown', long_description_content_type='text/markdown',
url='https://github.com/seleniumbase/SeleniumBase', url='https://github.com/seleniumbase/SeleniumBase',