Skip to content

Commit 0785ede

Browse files
emanloveemanlove
authored
Merge pull request #1896 from emanlove/remove-selenium2library-1826
Start removing references to Selenium2Library
2 parents 15b57e9 + 02fc863 commit 0785ede

File tree

3 files changed

+85
-94
lines changed

3 files changed

+85
-94
lines changed

‎README.rst‎

Lines changed: 9 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ SeleniumLibrary_ is a web testing library for `Robot Framework`_ that
1010
utilizes the Selenium_ tool internally. The project is hosted on GitHub_
1111
and downloads can be found from PyPI_.
1212

13-
SeleniumLibrary works with Selenium 3 and 4. It supports Python 3.6 or
13+
SeleniumLibrary currently works with Selenium 4. It supports Python 3.8 or
1414
newer. In addition to the normal Python_ interpreter, it works also
1515
with PyPy_.
1616

17-
SeleniumLibrary is based on the `old SeleniumLibrary`_ that was forked to
18-
Selenium2Library_ and then later renamed back to SeleniumLibrary.
19-
See the Versions_ and History_ sections below for more information about
20-
different versions and the overall project history.
17+
SeleniumLibrary is based on the "old SeleniumLibrary" that was forked to
18+
Selenium2Library and then later renamed back to SeleniumLibrary.
19+
See the `VERSIONS.rst`_ for more information about different versions and the
20+
overall project history.
2121

2222
.. image:: https://img.shields.io/pypi/v/robotframework-seleniumlibrary.svg?label=version
2323
:target: https://pypi.python.org/pypi/robotframework-seleniumlibrary
@@ -48,23 +48,8 @@ versions, but you still need to install `browser drivers`_ separately.
4848
The ``--upgrade`` option can be omitted when installing the library for the
4949
first time.
5050

51-
Those migrating from Selenium2Library_ can install SeleniumLibrary so that
52-
it is exposed also as Selenium2Library::
53-
54-
pip install --upgrade robotframework-selenium2library
55-
56-
The above command installs the normal SeleniumLibrary as well as a new
57-
Selenium2Library version that is just a thin wrapper to SeleniumLibrary.
58-
That allows importing Selenium2Library in tests while migrating to
59-
SeleniumLibrary.
60-
61-
To install the last legacy Selenium2Library_ version, use this command instead::
62-
63-
pip install robotframework-selenium2library==1.8.0
64-
65-
With recent versions of ``pip`` it is possible to install directly from the
66-
GitHub_ repository. To install latest source from the master branch, use
67-
this command::
51+
It is possible to install directly from the GitHub_ repository. To install
52+
latest source from the master branch, use this command::
6853

6954
pip install git+https://github.com/robotframework/SeleniumLibrary.git
7055

@@ -197,97 +182,30 @@ Community
197182
If the provided documentation is not enough, there are various community channels
198183
available:
199184

200-
- `robotframework-users`_ mailing list
201185
- ``#seleniumlibrary`` and ``#seleniumlibrary-dev`` channels in
202186
Robot Framework `Slack community`_
203187
- `Robot Framework forum`_ has channel for SeleniumLibrary.
204188
- SeleniumLibrary `issue tracker`_ for bug reports and concrete enhancement
205189
requests
206190
- `Other community channels`_ including paid support
207191

208-
Versions
209-
--------
210-
211-
SeleniumLibrary has over the years lived under SeleniumLibrary and
212-
Selenium2Library names and different library versions have supported
213-
different Selenium and Python versions. This is summarized in the table
214-
below and the History_ section afterwards explains the project history
215-
a bit more.
216-
217-
================================== ========================== ========================== ===============
218-
Project Selenium Version Python Version Comment
219-
================================== ========================== ========================== ===============
220-
SeleniumLibrary 2.9.2 and earlier Selenium 1 and 2 Python 2.5-2.7 The original SeleniumLibrary using Selenium RC API.
221-
Selenium2Library 1.8.0 and earlier Selenium 2 and 3 Python 2.6-2.7 Fork of SeleniumLibrary using Selenium WebDriver API.
222-
SeleniumLibrary 3.0 and 3.1 Selenium 2 and 3 Python 2.7 and 3.3+ Selenium2Library renamed and with Python 3 support and new architecture.
223-
SeleniumLibrary 3.2 Selenium 3 Python 2.7 and 3.4+ Drops Selenium 2 support.
224-
SeleniumLibrary 4.0 Selenium 3 Python 2.7 and 3.4+ Plugin API and support for event friging webdriver.
225-
SeleniumLibrary 4.1 Selenium 3 Python 2.7 and 3.5+ Drops Python 3.4 support.
226-
SeleniumLibrary 4.2 Selenium 3 Python 2.7 and 3.5+ Supports only Selenium 3.141.0 or newer.
227-
SeleniumLibrary 4.4 Selenium 3 and 4 Python 2.7 and 3.6+ New PythonLibCore and dropped Python 3.5 support.
228-
SeleniumLibrary 5.0 Selenium 3 and 4 Python 3.6+ Python 2 and Jython support is dropped.
229-
SeleniumLibrary 5.1 Selenium 3 and 4 Python 3.6+ Robot Framework 3.1 support is dropped.
230-
Selenium2Library 3.0 Depends on SeleniumLibrary Depends on SeleniumLibrary Thin wrapper for SeleniumLibrary 3.0 to ease transition.
231-
================================== ========================== ========================== ===============
232-
233-
History
234-
-------
235-
236-
SeleniumLibrary originally used the Selenium Remote Controller (RC) API.
237-
When Selenium 2 was introduced with the new but backwards incompatible
238-
WebDriver API, SeleniumLibrary kept using Selenium RC and separate
239-
Selenium2Library using WebDriver was forked. These projects contained
240-
mostly the same keywords and in most cases Selenium2Library was a drop-in
241-
replacement for SeleniumLibrary.
242-
243-
Over the years development of the old SeleniumLibrary stopped and also
244-
the Selenium RC API it used was deprecated. Selenium2Library was developed
245-
further and replaced the old library as the de facto web testing library
246-
for Robot Framework.
247-
248-
When Selenium 3 was released in 2016, it was otherwise backwards compatible
249-
with Selenium 2, but the deprecated Selenium RC API was removed. This had two
250-
important effects:
251-
252-
- The old SeleniumLibrary could not anymore be used with new Selenium versions.
253-
This project was pretty much dead.
254-
- Selenium2Library was badly named as it supported Selenium 3 just fine.
255-
This project needed a new name.
256-
257-
At the same time when Selenium 3 was released, Selenium2Library was going
258-
through larger architecture changes in order to ease future maintenance and
259-
to make adding Python 3 support easier. With all these big internal and
260-
external changes, it made sense to rename Selenium2Library back to
261-
SeleniumLibrary. This decision basically meant following changes:
262-
263-
- Create separate repository for the `old SeleniumLibrary`_ to preserve
264-
its history since Selenium2Library was forked.
265-
- Rename Selenium2Library project and the library itself to SeleniumLibrary_.
266-
- Add new Selenium2Library_ project to ease transitioning from Selenium2Library
267-
to SeleniumLibrary.
268-
269-
Going forward, all new development will happen in the new SeleniumLibrary
270-
project.
271192

272193
.. _Robot Framework: https://robotframework.org
273194
.. _Selenium: https://www.seleniumhq.org/
274195
.. _SeleniumLibrary: https://github.com/robotframework/SeleniumLibrary
275-
.. _Selenium2Library: https://github.com/robotframework/Selenium2Library
276-
.. _Old SeleniumLibrary: https://github.com/robotframework/OldSeleniumLibrary
277196
.. _pip: http://pip-installer.org
278197
.. _PyPI: https://pypi.python.org/pypi/robotframework-seleniumlibrary
279198
.. _GitHub: https://github.com/robotframework/SeleniumLibrary
280199
.. _Keyword Documentation: https://robotframework.org/SeleniumLibrary/SeleniumLibrary.html
281200
.. _Python: https://python.org
282201
.. _PyPy: https://pypy.org
283-
.. _Jython: https://jython.org/
284-
.. _IronPython: https://ironpython.net/
285202
.. _demo project: https://github.com/robotframework/WebDemo
286203
.. _Robot Framework User Guide: https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html
287204
.. _Robot Framework installation instructions: https://github.com/robotframework/robotframework/blob/master/INSTALL.rst
288-
.. _robotframework-users: https://groups.google.com/group/robotframework-users
289205
.. _extending documentation: https://github.com/robotframework/SeleniumLibrary/blob/master/docs/extending/extending.rst
290206
.. _Slack community: https://robotframework-slack-invite.herokuapp.com
291207
.. _Robot Framework forum: https://forum.robotframework.org/
292208
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues
293209
.. _Other community channels: https://robotframework.org/#community
210+
.. _VERSIONS.rst: https://github.com/robotframework/SeleniumLibrary/blob/master/VERSIONS.rst
211+

‎VERSIONS.rst‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
Versions
2+
--------
3+
4+
SeleniumLibrary has over the years lived under SeleniumLibrary and
5+
Selenium2Library names and different library versions have supported
6+
different Selenium and Python versions. This is summarized in the table
7+
below and the History_ section afterwards explains the project history
8+
a bit more.
9+
10+
================================== ========================== ========================== ===============
11+
Project Selenium Version Python Version Comment
12+
================================== ========================== ========================== ===============
13+
SeleniumLibrary 2.9.2 and earlier Selenium 1 and 2 Python 2.5-2.7 The original SeleniumLibrary using Selenium RC API.
14+
Selenium2Library 1.8.0 and earlier Selenium 2 and 3 Python 2.6-2.7 Fork of SeleniumLibrary using Selenium WebDriver API.
15+
SeleniumLibrary 3.0 and 3.1 Selenium 2 and 3 Python 2.7 and 3.3+ Selenium2Library renamed and with Python 3 support and new architecture.
16+
SeleniumLibrary 3.2 Selenium 3 Python 2.7 and 3.4+ Drops Selenium 2 support.
17+
SeleniumLibrary 4.0 Selenium 3 Python 2.7 and 3.4+ Plugin API and support for event friging webdriver.
18+
SeleniumLibrary 4.1 Selenium 3 Python 2.7 and 3.5+ Drops Python 3.4 support.
19+
SeleniumLibrary 4.2 Selenium 3 Python 2.7 and 3.5+ Supports only Selenium 3.141.0 or newer.
20+
SeleniumLibrary 4.4 Selenium 3 and 4 Python 2.7 and 3.6+ New PythonLibCore and dropped Python 3.5 support.
21+
SeleniumLibrary 5.0 Selenium 3 and 4 Python 3.6+ Python 2 and Jython support is dropped.
22+
SeleniumLibrary 5.1 Selenium 3 and 4 Python 3.6+ Robot Framework 3.1 support is dropped.
23+
Selenium2Library 3.0 Depends on SeleniumLibrary Depends on SeleniumLibrary Thin wrapper for SeleniumLibrary 3.0 to ease transition.
24+
================================== ========================== ========================== ===============
25+
26+
History
27+
-------
28+
29+
SeleniumLibrary originally used the Selenium Remote Controller (RC) API.
30+
When Selenium 2 was introduced with the new but backwards incompatible
31+
WebDriver API, SeleniumLibrary kept using Selenium RC and separate
32+
Selenium2Library using WebDriver was forked. These projects contained
33+
mostly the same keywords and in most cases Selenium2Library was a drop-in
34+
replacement for SeleniumLibrary.
35+
36+
Over the years development of the old SeleniumLibrary stopped and also
37+
the Selenium RC API it used was deprecated. Selenium2Library was developed
38+
further and replaced the old library as the de facto web testing library
39+
for Robot Framework.
40+
41+
When Selenium 3 was released in 2016, it was otherwise backwards compatible
42+
with Selenium 2, but the deprecated Selenium RC API was removed. This had two
43+
important effects:
44+
45+
- The old SeleniumLibrary could not anymore be used with new Selenium versions.
46+
This project was pretty much dead.
47+
- Selenium2Library was badly named as it supported Selenium 3 just fine.
48+
This project needed a new name.
49+
50+
At the same time when Selenium 3 was released, Selenium2Library was going
51+
through larger architecture changes in order to ease future maintenance and
52+
to make adding Python 3 support easier. With all these big internal and
53+
external changes, it made sense to rename Selenium2Library back to
54+
SeleniumLibrary. This decision basically meant following changes:
55+
56+
- Create separate repository for the `old SeleniumLibrary`_ to preserve
57+
its history since Selenium2Library was forked.
58+
- Rename Selenium2Library project and the library itself to SeleniumLibrary_.
59+
- Add new Selenium2Library_ project to ease transitioning from Selenium2Library
60+
to SeleniumLibrary.
61+
62+
All new development is happenning in the SeleniumLibrary project.
63+
64+
Installation of legacy Selenium2Library
65+
---------------------------------------
66+
To install the last legacy Selenium2Library_ version, use this command::
67+
68+
pip install robotframework-selenium2library==1.8.0
69+
70+
.. _SeleniumLibrary: https://github.com/robotframework/SeleniumLibrary
71+
.. _Selenium2Library: https://github.com/robotframework/Selenium2Library
72+
.. _Old SeleniumLibrary: https://github.com/robotframework/OldSeleniumLibrary

‎setup.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@
1313
Operating System :: OS Independent
1414
Programming Language :: Python
1515
Programming Language :: Python :: 3
16-
Programming Language :: Python :: 3.6
17-
Programming Language :: Python :: 3.7
1816
Programming Language :: Python :: 3.8
17+
Programming Language :: Python :: 3.9
18+
Programming Language :: Python :: 3.10
19+
Programming Language :: Python :: 3.11
1920
Programming Language :: Python :: 3 :: Only
2021
Topic :: Software Development :: Testing
2122
Framework :: Robot Framework
@@ -40,7 +41,7 @@
4041
keywords = 'robotframework testing testautomation selenium webdriver web',
4142
platforms = 'any',
4243
classifiers = CLASSIFIERS,
43-
python_requires = '>=3.6, <4',
44+
python_requires = '>=3.8, <3.12',
4445
install_requires = REQUIREMENTS,
4546
package_dir = {'': 'src'},
4647
packages = find_packages('src'),

0 commit comments

Comments
 (0)