Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 158 lines (109 sloc) 5.61 kB
54c2050 @rtomac Update readme files
authored
1 Selenium 2 (WebDriver) library for Robot Framework
2 ==================================================
3
6793340 @j1z0 updatd README with correct link to travis build image
j1z0 authored
4 .. image:: https://api.travis-ci.org/rtomac/robotframework-selenium2library.png
31c33a3 @zephraph Added and updated badges
zephraph authored
5 :target: http://travis-ci.org/rtomac/robotframework-selenium2library
30e361b @emanlove Beautify readme.RST
emanlove authored
6
31c33a3 @zephraph Added and updated badges
zephraph authored
7 .. image:: https://img.shields.io/pypi/v/robotframework-selenium2library.svg
8 :target: https://pypi.python.org/pypi/robotframework-selenium2library
9
10 .. image:: https://img.shields.io/pypi/dm/robotframework-selenium2library.svg
11 :target: https://pypi.python.org/pypi/robotframework-selenium2library
12
13 .. image:: https://img.shields.io/pypi/l/robotframework-selenium2library.svg
14 :target: http://www.apache.org/licenses/LICENSE-2.0
15
16 .. image:: https://robotframework-slack.herokuapp.com/badge.svg
17 :target: https://robotframework-slack.herokuapp.com
18 :alt: Slack channel
6793340 @j1z0 updatd README with correct link to travis build image
j1z0 authored
19
4ab16a8 @yanne Initial import
yanne authored
20
21 Introduction
22 ------------
23
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
24 Selenium2Library is a web testing library for `Robot Framework`_
1848011 @rtomac - Added robotframework >= 2.6.3 dependency to setup.py install_requires
authored
25 that leverages the `Selenium 2 (WebDriver)`_ libraries from the
54c2050 @rtomac Update readme files
authored
26 Selenium_ project.
27
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
28 It is modeled after (and forked from) the SeleniumLibrary_ library,
54c2050 @rtomac Update readme files
authored
29 but re-implemented to use Selenium 2 and WebDriver technologies.
4ab16a8 @yanne Initial import
yanne authored
30
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
31 - More information about this library can be found on the Wiki_ and in the `Keyword Documentation`_.
a8cc41e @laurentbristiel add links to INSTALL and BUILD files
laurentbristiel authored
32 - Installation information is found in the `INSTALL.rst`_ file.
33 - Developer information is found in `BUILD.rst`_ file.
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
34
35
9c81533 @kontulai Update README.rst
kontulai authored
36 Installation
37 ------------
38
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
39 Using ``pip``
40 '''''''''''''
41
42 The recommended installation method is using
43 `pip <http://pip-installer.org>`__::
9c81533 @kontulai Update README.rst
kontulai authored
44
45 pip install robotframework-selenium2library
46
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
47 The main benefit of using ``pip`` is that it automatically installs all
48 dependencies needed by the library. Other nice features are easy upgrading
49 and support for un-installation::
50
51 pip install --upgrade robotframework-selenium2library
52 pip uninstall robotframework-selenium2library
53
54 Notice that using ``--upgrade`` above updates both the library and all
55 its dependencies to the latest version. If you want, you can also install
56 a specific version or upgrade only the Selenium tool used by the library::
57
a77aeaa @emanlove Fixed spelling issue refering to pip installer
emanlove authored
58 pip install robotframework-selenium2library==1.4.1
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
59 pip install --upgrade selenium
60 pip install selenium==2.34
61
62 Proxy configuration
63 '''''''''''''''''''
64
65 If you are behind a proxy, you can use ``--proxy`` command line option
66 or set ``http_proxy`` and/or ``https_proxy`` environment variables to
67 configure ``pip`` to use it. If you are behind an authenticating NTLM proxy,
68 you may want to consider installing `CNTML <http://cntlm.sourceforge.net>`__
69 to handle communicating with it.
70
71 For more information about ``--proxy`` option and using pip with proxies
72 in general see:
73
74 - http://pip-installer.org/en/latest/usage.html
75 - http://stackoverflow.com/questions/9698557/how-to-use-pip-on-windows-behind-an-authenticating-proxy
76 - http://stackoverflow.com/questions/14149422/using-pip-behind-a-proxy
77
78 Manual installation
79 '''''''''''''''''''
80
81 If you do not have network connection or cannot make proxy to work, you need
82 to resort to manual installation. This requires installing both the library
83 and its dependencies yourself.
84
85 1) Make sure you have `Robot Framework installed
86 <http://code.google.com/p/robotframework/wiki/Installation>`__.
87
88 2) Download source distributions (``*.tar.gz``) for the library and its
89 dependencies:
90
91 - https://pypi.python.org/pypi/robotframework-selenium2library
92 - https://pypi.python.org/pypi/selenium
93 - https://pypi.python.org/pypi/decorator
94
95 3) Extract each source distribution to a temporary location.
96
97 4) Go each created directory from the command line and install each project
98 using::
99
100 python setup.py install
101
102 If you are on Windows, and there are Windows installers available for
103 certain projects, you can use them instead of source distributions.
104 Just download 32bit or 64bit installer depending on your system,
105 double-click it, and follow the instructions.
9c81533 @kontulai Update README.rst
kontulai authored
106
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
107 Directory Layout
108 ----------------
109
110 demo/
111 A simple demonstration, with an application running on localhost
112
113 doc/
114 Keyword documentation
115
116 src/
117 Python source code
118
4ab16a8 @yanne Initial import
yanne authored
119
120 Usage
121 -----
122
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
123 To write tests with Robot Framework and Selenium2Library,
54c2050 @rtomac Update readme files
authored
124 Selenium2Library must be imported into your Robot test suite.
125 See `Robot Framework User Guide`_ for more information.
4ab16a8 @yanne Initial import
yanne authored
126
127
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
128 Running the Demo
129 ----------------
4ab16a8 @yanne Initial import
yanne authored
130
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
131 The demo directory contains an easily executable demo for Robot Framework
1848011 @rtomac - Added robotframework >= 2.6.3 dependency to setup.py install_requires
authored
132 using Selenium2Library. To run the demo, run::
4ab16a8 @yanne Initial import
yanne authored
133
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
134 python demo/rundemo.py
4ab16a8 @yanne Initial import
yanne authored
135
1848011 @rtomac - Added robotframework >= 2.6.3 dependency to setup.py install_requires
authored
136 E.g.::
137
138 python demo/rundemo.py demo/login_tests
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
139
a6e2c7f @emanlove Update README.rst
emanlove authored
140 Getting Help
141 ------------
142 The `user group for Robot Framework`_ is the best place to get help. Consider including in the post:
143
144 - Full description of what you are trying to do and expected outcome
145 - Version number of Selenium2Library, Robot Framework, and Selenium
146 - Traceback or other debug output containing error information
4ab16a8 @yanne Initial import
yanne authored
147
1fb0158 @pekkaklarck Enhanced installation instructions to README.rst
pekkaklarck authored
148 .. _Robot Framework: http://robotframework.org
4ab16a8 @yanne Initial import
yanne authored
149 .. _Selenium: http://selenium.openqa.org
54c2050 @rtomac Update readme files
authored
150 .. _Selenium 2 (WebDriver): http://seleniumhq.org/docs/03_webdriver.html
151 .. _SeleniumLibrary: http://code.google.com/p/robotframework-seleniumlibrary/
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
152 .. _Wiki: https://github.com/rtomac/robotframework-selenium2library/wiki
153 .. _Keyword Documentation: http://rtomac.github.com/robotframework-selenium2library/doc/Selenium2Library.html
a8cc41e @laurentbristiel add links to INSTALL and BUILD files
laurentbristiel authored
154 .. _INSTALL.rst: https://github.com/rtomac/robotframework-selenium2library/blob/master/INSTALL.rst
155 .. _BUILD.rst: https://github.com/rtomac/robotframework-selenium2library/blob/master/BUILD.rst
c3e41a4 @rtomac Clean up readme documentation, including new BUILD.rest file
authored
156 .. _Robot Framework User Guide: http://code.google.com/p/robotframework/wiki/UserGuide
a6e2c7f @emanlove Update README.rst
emanlove authored
157 .. _user group for Robot Framework: http://groups.google.com/group/robotframework-users
Something went wrong with that request. Please try again.