Merge pull request #256 from seleniumbase/update-styling

Update console scripts, styling, and simplify installation

Author: mdmintz

README.md

@@ -1,12 +1,12 @@
 [<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://img.shields.io/badge/python-2.7,_3.x-22AADD.svg" alt="Python versions" />](https://github.com/seleniumbase/SeleniumBase/blob/master/.travis.yml) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/github/issues-closed-raw/seleniumbase/SeleniumBase.svg" alt="Closed Issues" />](https://github.com/seleniumbase/SeleniumBase/issues?q=is%3Aissue+is%3Aclosed) [<img src="https://img.shields.io/badge/pypi-seleniumbase-forestgreen.svg" alt="pypi" />](https://pypi.python.org/pypi/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 />
+[<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)<br />
 
-A complete framework for web automation, end-to-end testing, and [interactive walkthroughs](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). SeleniumBase uses [Pytest](https://docs.pytest.org/en/latest/) for running Python scripts, while using [WebDriver](https://www.seleniumhq.org/) for controlling web browsers.
+A fast, simple, and reliable framework for automating UI testing and [prototyping JS tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). SeleniumBase uses [Pytest](https://docs.pytest.org/en/latest/) for running Python scripts, and [WebDriver](https://www.seleniumhq.org/) for controlling web browsers. [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)
 
 ## <img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_box2.png" title="SeleniumBase" height="32"> Quick Start
 
-(<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>)
+(<i>Requires [Git](https://git-scm.com/) and [Python](https://www.python.org/downloads/) [<img src="https://img.shields.io/badge/python-2.7,_3.x-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>)
 
 #### Clone SeleniumBase from GitHub:
 ```
@@ -26,6 +26,7 @@ pip install -U -r requirements.txt
 python setup.py install
 ```
 * (Use ``python setup.py develop`` if configuring seleniumbase inside a virtual environment.)
+* (You can also get seleniumbase from the Python Package Index, [<img src="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg" alt="pypi" />](https://pypi.python.org/pypi/seleniumbase))
 
 #### Install a web driver to the [seleniumbase/drivers](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/drivers) folder:
 ```
@@ -151,7 +152,7 @@ pip install -r requirements.txt --upgrade
 python setup.py install
 ```
 
-If you're installing SeleniumBase from the [Python Package Index](https://pypi.python.org/pypi/seleniumbase), use:
+If you're installing SeleniumBase from the [Python Package Index](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), use:
 ```
 pip install -U seleniumbase --no-cache-dir
 ```
@@ -729,11 +730,14 @@ Now you can parse through the email if you're looking for specific text or want
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_box2.png" title="SeleniumBase" height="32"> Wrap-Up
 
-Congratulations on getting started with SeleniumBase!
+#### Congratulations on getting started with SeleniumBase!
 
 <i>**Questions or Comments?**</i><br />
 [![Join the chat at https://gitter.im/seleniumbase/SeleniumBase](https://badges.gitter.im/seleniumbase/SeleniumBase.svg)](https://gitter.im/seleniumbase/SeleniumBase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)<br />
 
+If you see something, say something! We are very active in resolving issues. [<img src="https://img.shields.io/github/issues-closed-raw/seleniumbase/SeleniumBase.svg" alt="Closed Issues" />](https://github.com/seleniumbase/SeleniumBase/issues?q=is%3Aissue+is%3Aclosed)
+
 [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="http://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE)

examples/tour_examples/ReadMe.md

@@ -1,6 +1,6 @@
 ## SeleniumBase Website Tours
 
-SeleniumBase Tours utilize your choice of 4 different Javascript libraries for creating & running tours, demos, and walkthroughs on any website: **[Shepherd](https://shipshapecode.github.io/shepherd/docs/welcome/)**, **[Bootstrap Tour](http://bootstraptour.com/)**, **[IntroJS](https://introjs.com/)**, and **[Hopscotch](http://linkedin.github.io/hopscotch/)**. Choose your favorite one to use!
+SeleniumBase Tours utilize your choice of 4 different JavaScript libraries for creating & running tours, demos, and walkthroughs on any website: **[Shepherd](https://shipshapecode.github.io/shepherd/docs/welcome/)**, **[Bootstrap Tour](http://bootstraptour.com/)**, **[IntroJS](https://introjs.com/)**, and **[Hopscotch](http://linkedin.github.io/hopscotch/)**. Choose your favorite one to use!
 
 Example tour:
 
@@ -9,33 +9,33 @@ Example tour:
 
 ### Creating a new tour:
 
-By default, Shepherd JS is used when creating a tour with:
+#### To create a tour utilizing the Shepherd JS Library, use one of the following:
 
-``self.create_tour()``
+``self.create_shepherd_tour()``
 
-You can also do:
+OR
 
-``self.create_shepherd_tour()``
+``self.create_tour(theme="shepherd")``
 
-With the ``create_tour()`` and ``create_shepherd_tour()`` methods, you can pass a default theme to change the look & feel of the tour steps. Valid themes for Shepherd Tours are ``dark``, ``light`` / ``arrows``, ``default``, ``square``, and ``square-dark``.
+You can pass a custom theme to change the look & feel of Shepherd tours. Valid themes for Shepherd Tours are ``dark``, ``light`` / ``arrows``, ``default``, ``square``, and ``square-dark``.
 
-To create a tour utilizing the Bootstrap Tour Library, you can use either of the following:
+#### To create a tour utilizing the Bootstrap Tour Library, use one of the following:
 
 ``self.create_bootstrap_tour()``
 
 OR
 
 ``self.create_tour(theme="bootstrap")``
 
-To create a tour utilizing the Intro JS Library, you can use either of the following:
+#### To create a tour utilizing the Intro JS Library, use one of the following:
 
 ``self.create_introjs_tour()``
 
 OR
 
 ``self.create_tour(theme="introjs")``
 
-To create a tour utilizing the Hopscotch JS Library, you can use either of the following:
+#### To create a tour utilizing the Hopscotch JS Library, use one of the following:
 
 ``self.create_hopscotch_tour()``
 
@@ -45,7 +45,7 @@ OR
 
 ### Adding a step to a tour:
 
-To add a tour step, use the following: (Only ``message`` is required. The other args are optional.)
+#### To add a tour step, use the following:
 
 ``self.add_tour_step(message, css_selector, title, alignment, theme)``
 
@@ -100,12 +100,12 @@ pytest google_tour.py
 
 ### Exporting a Tour:
 
-If you want to save the tour you created as a Javascript file, use:
+If you want to save the tour you created as a JavaScript file, use:
 
 ``self.export_tour()``
 
 OR
 
 ``self.export_tour(name=None, filename="my_tour.js")``
 
-(``name`` is optional, needed only if you were creating multiple tours at once. ``filename`` is the name of the file to save the Javascript to.) Once you've exported your tour, you can use it outside of SeleniumBase. You can even copy the tour's Javascript code to the Console of your web browser to play the tour from there (you need to be on the correct web page for it to work).
+(``name`` is optional unless you gave custom names to your tours when you created them. ``filename`` is the name of the file to save the JavaScript to.) Once you've exported your tour, you can use it outside of SeleniumBase. You can even copy the tour's JavaScript code to the Console of your web browser to play the tour from there (you need to be on the correct web page for it to work).

install.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+python -m pip install --upgrade pip
+pip install -e . --upgrade --no-cache-dir --progress-bar off
+seleniumbase install chromedriver
+seleniumbase install geckodriver

install.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+python -m pip install --upgrade pip
+pip install -e . --upgrade --no-cache-dir --progress-bar off
+seleniumbase install chromedriver
+seleniumbase install geckodriver

seleniumbase/console_scripts/logo_helper.py

@@ -15,46 +15,48 @@
 
 def get_seleniumbase_logo():
     colorama.init(autoreset=True)
-    c1 = colorama.Fore.BLUE + colorama.Back.CYAN
-    c2 = colorama.Fore.CYAN + colorama.Back.BLUE
+    c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
+    c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
+    c3 = colorama.Back.CYAN
+    c4 = colorama.Back.GREEN
     cr = colorama.Style.RESET_ALL
     sb = " "
-    sb += c1
+    sb += cr
     sb += "\n"
     sb += c1
     sb += "   ______     __           _                 "
     sb += c2
     sb += "____                "
-    sb += c1
+    sb += cr
     sb += "\n"
     sb += c1
     sb += "  / ____/__  / /__  ____  (_)_  ______ ___  "
     sb += c2
     sb += "/ __ `____  ________ "
-    sb += c1
+    sb += cr
     sb += "\n"
     sb += c1
     sb += "  \\__ \\/ _ \\/ / _ \\/ __ \\/ / / / / __ `__ \\"
     sb += c2
     sb += "/ /_/ / __ `/ ___/ _ \\"
-    sb += c1
+    sb += cr
     sb += "\n"
     sb += c1
     sb += " ___/ /  __/ /  __/ / / / / /_/ / / / / / "
     sb += c2
     sb += "/ /_) / /_/ (__  )  __/"
-    sb += c1
+    sb += cr
     sb += "\n"
     sb += c1
     sb += "/____/\\___/_/\\___/_/ /_/_/\\__,_/_/ /_/ /_"
     sb += c2
     sb += "/_____/\\__,_/____/\\___/ "
-    sb += c1
+    sb += cr
     sb += "\n"
-    sb += c1
-    sb += "                                        "
-    sb += c2
-    sb += "                         "
-    sb += c1
+    sb += c3
+    sb += "                                         "
+    sb += c4
+    sb += "                        "
+    sb += cr
     sb += cr
     return sb

seleniumbase/console_scripts/run.py

@@ -27,8 +27,7 @@ def show_usage():
     show_basic_usage()
     print('Type "seleniumbase --help" for details on all commands.')
     print('Type "seleniumbase help [COMMAND]" for specific command info.')
-    print('Type "pytest [FILE_OR_DIR]" to run tests in the given location.')
-    print('Type "pytest --help" to learn more about running tests.\n')
+    print('Use "pytest" for running tests.\n')
 
 
 def show_basic_usage():
@@ -38,15 +37,14 @@ def show_basic_usage():
     print('Usage: "seleniumbase [COMMAND] [PARAMETERS]"')
     print(' * (Example: "seleniumbase install chromedriver")')
     print("")
-    print("Commands with parameters:")
-    print("")
-    print("  seleniumbase")
-    print("     install [DRIVER_NAME]")
-    print("     mkdir [NEW_TEST_DIRECTORY_NAME]")
-    print("     convert [PYTHON_WEBDRIVER_UNITTEST_FILE]")
-    print("     download server")
-    print("     grid-hub {start|stop|restart} [OPTIONS]")
-    print("     grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]")
+    print("Commands:")
+    print("   seleniumbase")
+    print("      install [DRIVER_NAME]")
+    print("      mkdir [NEW_TEST_DIRECTORY_NAME]")
+    print("      convert [PYTHON_WEBDRIVER_UNITTEST_FILE]")
+    print("      download server")
+    print("      grid-hub {start|stop|restart} [OPTIONS]")
+    print("      grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]")
     print("")
 
 
@@ -104,7 +102,7 @@ def show_download_usage():
     print("")
     print("  Usage:")
     print("            seleniumbase download [ITEM]")
-    print("                  (Options: server")
+    print("                  (Choices: server)")
     print("  Example:")
     print("            seleniumbase download server")
     print("  Output:")

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.17.12',
+    version='1.17.13',
     description='All-in-One Test Automation Framework',
     long_description=long_description,
     long_description_content_type='text/markdown',