You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[<imgsrc="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases)[<imgsrc="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master"alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase)[<imgsrc="https://badges.gitter.im/seleniumbase/SeleniumBase.svg"alt="Join the Gitter Chat" />](https://gitter.im/seleniumbase/SeleniumBase)<br />
4
4
5
-
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.
5
+
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.[<imgsrc="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg"alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)
(<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>)
9
+
(<i>Requires [Git](https://git-scm.com/) and [Python](https://www.python.org/downloads/)[<imgsrc="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>)
* (Use ``python setup.py develop`` if configuring seleniumbase inside a virtual environment.)
29
+
* (You can also get seleniumbase from the Python Package Index, [<imgsrc="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg"alt="pypi" />](https://pypi.python.org/pypi/seleniumbase))
29
30
30
31
#### Install a web driver to the [seleniumbase/drivers](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/drivers) folder:
If you're installing SeleniumBase from the [Python Package Index](https://pypi.python.org/pypi/seleniumbase), use:
155
+
If you're installing SeleniumBase from the [Python Package Index](https://pypi.python.org/pypi/seleniumbase)[<imgsrc="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg"alt="pypi" />](https://pypi.python.org/pypi/seleniumbase), use:
155
156
```
156
157
pip install -U seleniumbase --no-cache-dir
157
158
```
@@ -729,11 +730,14 @@ Now you can parse through the email if you're looking for specific text or want
Congratulations on getting started with SeleniumBase!
733
+
#### Congratulations on getting started with SeleniumBase!
733
734
734
735
<i>**Questions or Comments?**</i><br />
735
736
[](https://gitter.im/seleniumbase/SeleniumBase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)<br />
736
737
738
+
If you see something, say something! We are very active in resolving issues. [<imgsrc="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)
Copy file name to clipboardExpand all lines: examples/tour_examples/ReadMe.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## SeleniumBase Website Tours
2
2
3
-
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!
3
+
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!
4
4
5
5
Example tour:
6
6
@@ -9,33 +9,33 @@ Example tour:
9
9
10
10
### Creating a new tour:
11
11
12
-
By default, Shepherd JS is used when creating a tour with:
12
+
#### To create a tour utilizing the Shepherd JS Library, use one of the following:
13
13
14
-
``self.create_tour()``
14
+
``self.create_shepherd_tour()``
15
15
16
-
You can also do:
16
+
OR
17
17
18
-
``self.create_shepherd_tour()``
18
+
``self.create_tour(theme="shepherd")``
19
19
20
-
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``.
20
+
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``.
21
21
22
-
To create a tour utilizing the Bootstrap Tour Library, you can use either of the following:
22
+
#### To create a tour utilizing the Bootstrap Tour Library, use one of the following:
23
23
24
24
``self.create_bootstrap_tour()``
25
25
26
26
OR
27
27
28
28
``self.create_tour(theme="bootstrap")``
29
29
30
-
To create a tour utilizing the Intro JS Library, you can use either of the following:
30
+
#### To create a tour utilizing the Intro JS Library, use one of the following:
31
31
32
32
``self.create_introjs_tour()``
33
33
34
34
OR
35
35
36
36
``self.create_tour(theme="introjs")``
37
37
38
-
To create a tour utilizing the Hopscotch JS Library, you can use either of the following:
38
+
#### To create a tour utilizing the Hopscotch JS Library, use one of the following:
39
39
40
40
``self.create_hopscotch_tour()``
41
41
@@ -45,7 +45,7 @@ OR
45
45
46
46
### Adding a step to a tour:
47
47
48
-
To add a tour step, use the following: (Only ``message`` is required. The other args are optional.)
(``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).
111
+
(``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).
0 commit comments