@@ -11,25 +11,88 @@ Selenium 2 (WebDriver) library for Robot Framework
1111Introduction
1212------------
1313
14- Selenium2Library is a web testing library for Robot Framework
14+ Selenium2Library is a web testing library for ` Robot Framework `_
1515that leverages the `Selenium 2 (WebDriver) `_ libraries from the
1616Selenium _ project.
1717
18- It is modeled after (and forked from) the SeleniumLibrary _ library,
18+ It is modeled after (and forked from) the SeleniumLibrary _ library,
1919but re-implemented to use Selenium 2 and WebDriver technologies.
2020
2121- More information about this library can be found on the Wiki _ and in the `Keyword Documentation `_.
22- - Installation information is found in the `INSTALL.rst ` file.
23- - Developer information is found in `BUILD.rst ` file.
22+ - Installation information is found in the `INSTALL.rst `_ file.
23+ - Developer information is found in `BUILD.rst `_ file.
2424
2525
2626Installation
2727------------
2828
29- You can install Selenium2Library using pip, with the following command
29+ Using ``pip ``
30+ '''''''''''''
31+
32+ The recommended installation method is using
33+ `pip <http://pip-installer.org >`__::
3034
3135 pip install robotframework-selenium2library
3236
37+ The main benefit of using ``pip `` is that it automatically installs all
38+ dependencies needed by the library. Other nice features are easy upgrading
39+ and support for un-installation::
40+
41+ pip install --upgrade robotframework-selenium2library
42+ pip uninstall robotframework-selenium2library
43+
44+ Notice that using ``--upgrade `` above updates both the library and all
45+ its dependencies to the latest version. If you want, you can also install
46+ a specific version or upgrade only the Selenium tool used by the library::
47+
48+ pip install robotframework-selenium2library==1.4.1
49+ pip install --upgrade selenium
50+ pip install selenium==2.34
51+
52+ Proxy configuration
53+ '''''''''''''''''''
54+
55+ If you are behind a proxy, you can use ``--proxy `` command line option
56+ or set ``http_proxy `` and/or ``https_proxy `` environment variables to
57+ configure ``pip `` to use it. If you are behind an authenticating NTLM proxy,
58+ you may want to consider installing `CNTML <http://cntlm.sourceforge.net >`__
59+ to handle communicating with it.
60+
61+ For more information about ``--proxy `` option and using pip with proxies
62+ in general see:
63+
64+ - http://pip-installer.org/en/latest/usage.html
65+ - http://stackoverflow.com/questions/9698557/how-to-use-pip-on-windows-behind-an-authenticating-proxy
66+ - http://stackoverflow.com/questions/14149422/using-pip-behind-a-proxy
67+
68+ Manual installation
69+ '''''''''''''''''''
70+
71+ If you do not have network connection or cannot make proxy to work, you need
72+ to resort to manual installation. This requires installing both the library
73+ and its dependencies yourself.
74+
75+ 1) Make sure you have `Robot Framework installed
76+ <http://code.google.com/p/robotframework/wiki/Installation> `__.
77+
78+ 2) Download source distributions (``*.tar.gz ``) for the library and its
79+ dependencies:
80+
81+ - https://pypi.python.org/pypi/robotframework-selenium2library
82+ - https://pypi.python.org/pypi/selenium
83+ - https://pypi.python.org/pypi/decorator
84+
85+ 3) Extract each source distribution to a temporary location.
86+
87+ 4) Go each created directory from the command line and install each project
88+ using::
89+
90+ python setup.py install
91+
92+ If you are on Windows, and there are Windows installers available for
93+ certain projects, you can use them instead of source distributions.
94+ Just download 32bit or 64bit installer depending on your system,
95+ double-click it, and follow the instructions.
3396
3497Directory Layout
3598----------------
47110Usage
48111-----
49112
50- To write tests with Robot Framework and Selenium2Library,
113+ To write tests with Robot Framework and Selenium2Library,
51114Selenium2Library must be imported into your Robot test suite.
52115See `Robot Framework User Guide `_ for more information.
53116
@@ -63,7 +126,7 @@ using Selenium2Library. To run the demo, run::
63126E.g.::
64127
65128 python demo/rundemo.py demo/login_tests
66-
129+
67130Getting Help
68131------------
69132The `user group for Robot Framework `_ is the best place to get help. Consider including in the post:
@@ -72,10 +135,13 @@ The `user group for Robot Framework`_ is the best place to get help. Consider in
72135- Version number of Selenium2Library, Robot Framework, and Selenium
73136- Traceback or other debug output containing error information
74137
138+ .. _Robot Framework : http://robotframework.org
75139.. _Selenium : http://selenium.openqa.org
76140.. _Selenium 2 (WebDriver) : http://seleniumhq.org/docs/03_webdriver.html
77141.. _SeleniumLibrary : http://code.google.com/p/robotframework-seleniumlibrary/
78142.. _Wiki : https://github.com/rtomac/robotframework-selenium2library/wiki
79143.. _Keyword Documentation : http://rtomac.github.com/robotframework-selenium2library/doc/Selenium2Library.html
144+ .. _INSTALL.rst : https://github.com/rtomac/robotframework-selenium2library/blob/master/INSTALL.rst
145+ .. _BUILD.rst : https://github.com/rtomac/robotframework-selenium2library/blob/master/BUILD.rst
80146.. _Robot Framework User Guide : http://code.google.com/p/robotframework/wiki/UserGuide
81147.. _user group for Robot Framework : http://groups.google.com/group/robotframework-users
0 commit comments