@@ -7,17 +7,18 @@ SeleniumLibrary
77Introduction
88------------
99
10- SeleniumLibrary _ is a web testing library for `Robot Framework `_
11- that utilizes the Selenium _ tool internally. See `keyword documentation `_
10+ SeleniumLibrary _ is a web testing library for `Robot Framework `_ that
11+ utilizes the Selenium _ tool internally. The project is hosted on GitHub _
12+ and downloads can be found from PyPI _. See `keyword documentation `_
1213for available keywords and more information about the library in general.
1314
14- SeleniumLibrary requires Selenium 2.53.6 or newer. It works with Python 2.7
15- as well as with Python 3.3 or newer.
15+ SeleniumLibrary works with Selenium 2.53.6 or newer, including Selenium 3.
16+ It supports Python 2.7 as well as Python 3.3 or newer.
1617
1718SeleniumLibrary is based on the `old SeleniumLibrary `_ that was forked to
1819Selenium2Library _ and then later renamed back to SeleniumLibrary.
19- See the ` History `_ section below for more information about different
20- versions.
20+ See the Versions _ and History _ sections below for more information about
21+ different versions and the overall project history .
2122
2223The new SeleniumLibrary is currently in pre-release phase. The final
2324SeleniumLibrary 3.0 release is planned for early September.
@@ -38,6 +39,8 @@ The recommended installation method is using pip_::
3839
3940 pip install --pre --upgrade robotframework-seleniumlibrary
4041
42+ Running this command installs also the latest Selenium and Robot Framework
43+ versions, but you still need to install `browser drivers `_ separately.
4144Notice that the ``--pre `` option is needed to get the current SeleniumLibrary,
4245not the `old SeleniumLibrary `_, until the final SeleniumLibrary 3.0 is
4346released. The ``--upgrade `` option can be omitted when installing the
@@ -57,7 +60,36 @@ To install the last legacy Selenium2Library_ version, use this command instead::
5760
5861 pip install robotframework-selenium2library==1.8.0
5962
60- See `INSTALL.rst `_ for more details about installation.
63+ An alternative to using ``pip `` is getting the project source code either
64+ from a source distribution at PyPI _ or by cloning the GitHub _ repository,
65+ and installing the code using ``python setup.py install ``. This approach
66+ does not install Selenium or other dependencies, so they need to be installed
67+ separately.
68+
69+ See `Robot Framework installation instructions `_ for detailed information
70+ about installing Python and Robot Framework itself. For more details about
71+ using ``pip `` see `its own documentation <pip _>`__.
72+
73+ Browser drivers
74+ ---------------
75+
76+ After installing the library, you still need to install browser and
77+ operating system specific browser drivers for all those browsers you
78+ want to use in tests. These are the exact same drivers you need to use with
79+ Selenium also when not using SeleniumLibrary. More information about
80+ drivers can be found from `Selenium documentation `__.
81+
82+ The general approach to install a browser driver is downloading a right
83+ driver, such as ``chromedriver `` for Chrome, and placing it into
84+ a directory that is in PATH __. Drivers for different browsers
85+ can be found via Selenium documentation or by using your favorite
86+ search engine with a search term like ``selenium chrome browser driver ``.
87+ New browser driver versions are released to support features in
88+ new browsers, fix bug, or otherwise, and you need to keep an eye on them
89+ to know when to update drivers you use.
90+
91+ __ https://seleniumhq.github.io/selenium/docs/api/py/index.html#drivers
92+ __ https://en.wikipedia.org/wiki/PATH_(variable)
6193
6294Usage
6395-----
@@ -136,6 +168,26 @@ available:
136168 requests
137169- `Other support forums `_ including paid support
138170
171+ Versions
172+ --------
173+
174+ SeleniumLibrary has over the years lived under SeleniumLibrary and
175+ Selenium2Library names and different library versions have supported
176+ different Selenium and Python versions. This is summarized in the table
177+ below and the History _ section afterwards explains the project history
178+ a bit more.
179+
180+ ================================== ================ =================== ===============
181+ Project Selenium Version Python Version Comment
182+ ================================== ================ =================== ===============
183+ SeleniumLibrary 2.9.2 and earlier Selenium 1 and 2 Python 2.5-2.7 The original SeleniumLibrary using Selenium RC API.
184+ Selenium2Library 1.8.0 and earlier Selenium 2 and 3 Python 2.6-2.7 Fork of SeleniumLibrary using Selenium WebDriver API.
185+ SeleniumLibrary 3.0 and newer Selenium 2 and 3 Python 2.7 and 3.3+ Selenium2Library renamed and with Python 3 support and new architecture.
186+ Selenium2Library 3.0 and newer Selenium 2 and 3 Python 2.7 and 3.3+ Thin wrapper for SeleniumLibrary 3.0 to ease transition.
187+ ================================== ================ =================== ===============
188+
189+ The only project that is developed further is SeleniumLibrary 3.
190+
139191History
140192-------
141193
@@ -181,11 +233,12 @@ project.
181233.. _Selenium2Library : https://github.com/robotframework/Selenium2Library
182234.. _Old SeleniumLibrary : https://github.com/robotframework/OldSeleniumLibrary
183235.. _pip : http://pip-installer.org
236+ .. _PyPI : https://pypi.python.org
237+ .. _GitHub : https://github.com/robotframework/SeleniumLibrary
184238.. _Keyword Documentation : http://robotframework.org/SeleniumLibrary/SeleniumLibrary.html
185- .. _INSTALL.rst : https://github.com/robotframework/SeleniumLibrary/blob/master/INSTALL.rst
186- .. _BUILD.rst : https://github.com/robotframework/SeleniumLibrary/blob/master/BUILD.rst
187239.. _demo project : https://bitbucket.org/robotframework/webdemo
188240.. _Robot Framework User Guide : http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html
241+ .. _Robot Framework installation instructions : https://github.com/robotframework/robotframework/blob/master/INSTALL.rst
189242.. _robotframework-users : http://groups.google.com/group/robotframework-users
190243.. _Slack community : https://robotframework-slack-invite.herokuapp.com
191244.. _issue tracker : https://github.com/robotframework/SeleniumLibrary/issues
0 commit comments