Skip to content

Commit ac28d1d

Browse files
committed
updated INSTALL.rst for version 3.0. robotframework#2222
1 parent 1ed364d commit ac28d1d

File tree

1 file changed

+22
-61
lines changed

1 file changed

+22
-61
lines changed

INSTALL.rst

Lines changed: 22 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,9 @@ Introduction
2727
`Robot Framework <http://robotframework.org>`_ is implemented with `Python
2828
<http://python.org>`_ and also runs on `Jython <http://jython.org>`_ (JVM) and
2929
`IronPython <http://ironpython.net>`_ (.NET). Before installing the framework,
30-
an obvious precondition_ is installing at least one of these interpreters. Note
31-
that Python 3 will be supported by the upcoming Robot Framework 3.0, and there
32-
is also an `un-official Python 3 port
33-
<https://pypi.python.org/pypi/robotframework-python3>`_ available.
30+
an obvious precondition_ is installing at least one of these interpreters.
31+
Robot Framework 3.0 and newer support Python versions 2.6, 2.7, and versions 3.3
32+
and later.
3433

3534
Different ways to install Robot Framework itself are listed below and explained
3635
more thoroughly in subsequent sections.
@@ -51,11 +50,6 @@ more thoroughly in subsequent sections.
5150
<https://pypi.python.org/pypi/robotframework>`_ or by cloning the
5251
`GitHub repository <https://github.com/robotframework/robotframework>`_ .
5352

54-
`Using Windows installer`_
55-
There are graphical installers for both 32 bit and 64 bit Windows systems,
56-
both available on PyPI_. They will not created for upcoming Robot Framework
57-
3.0 anymore.
58-
5953
`Standalone JAR distribution`_
6054
If running tests with Jython is enough, the easiest approach is downloading
6155
the standalone ``robotframework-<version>.jar`` from `Maven central
@@ -96,23 +90,13 @@ a good place to start is http://python.org. There you can download a suitable
9690
installer and get more information about the installation process and Python
9791
in general.
9892

99-
Robot Framework 2.9 supports Python 2.6 and 2.7, and upcoming Robot Framework
100-
3.0 supports those and also Python versions 3.3 and up. If you need Python 3
101-
support earlier, you can use the `un-official Python 3 port`_. If you need to
102-
use older Python versions, Robot Framework 2.5-2.8 support Python 2.5 and Robot
103-
Framework 2.0-2.1 support Python 2.3 and 2.4.
104-
105-
On Windows it is recommended to install Python to all users and to run the
106-
installer as an administrator. Additionally, environment variable
107-
``PYTHONCASEOK`` must not be set.
93+
Robot Framework 3.0 later support Python 2.6 and 2.7, and versions 3.3 and up.
94+
If you need to use older Python versions, Robot Framework 2.5-2.8 support
95+
Python 2.5 and Robot Framework 2.0-2.1 support Python 2.3 and 2.4.
10896

10997
After installing Python, you probably still want to `configure PATH`_ to make
11098
the ``pybot`` `runner script`_ executable on the command prompt.
11199

112-
.. tip:: Latest Python Windows installers allow setting ``PATH`` as part of
113-
the installation. This is disabled by default, but `Add python.exe
114-
to Path` can be enabled on the `Customize Python` screen.
115-
116100
Jython installation
117101
~~~~~~~~~~~~~~~~~~~
118102

@@ -169,12 +153,6 @@ installed with should be automatically in the ``PATH`` and no extra actions
169153
needed. On Windows and with other interpreters the ``PATH`` must be configured
170154
separately.
171155

172-
.. tip:: Latest Python Windows installers allow setting ``PATH`` as part of
173-
the installation. This is disabled by default, but `Add python.exe
174-
to Path` can be enabled on the `Customize Python` screen. It will
175-
set both Python installation directory and :file:`Scripts` directory
176-
to ``PATH``.
177-
178156
What directories to add to ``PATH``
179157
'''''''''''''''''''''''''''''''''''
180158

@@ -343,7 +321,7 @@ and examples.
343321
pip uninstall robotframework
344322

345323
# Install a local file (works without network connection)
346-
pip install robotframework-2.9.tar.gz
324+
pip install robotframework-3.0.tar.gz
347325

348326
Notice that pip 1.4 and newer will only install stable releases by default.
349327
If you want to install an alpha, beta or release candidate, you need to either
@@ -394,13 +372,13 @@ it from the command line using any of the supported interpreters:
394372

395373
.. sourcecode:: bash
396374

397-
# Installing with Python. Creates `pybot` and `rebot` scripts.
375+
# Installing with Python. Creates `robot`, `pybot` and `rebot` scripts.
398376
python setup.py install
399377

400-
# Installing with Jython. Creates `jybot` and `jyrebot` scripts.
378+
# Installing with Jython. Creates `robot`, `rebot`, `jybot` and `jyrebot` scripts.
401379
jython setup.py install
402380

403-
# Installing with IronPython. Creates `ipybot` and `ipyrebot` scripts.
381+
# Installing with IronPython. Creates `robot`, `rebot`, `ipybot` and `ipyrebot` scripts.
404382
ipy setup.py install
405383

406384
The ``setup.py`` script accepts several arguments allowing, for example,
@@ -411,26 +389,8 @@ rights. It is also used for creating different distribution packages. Run
411389
Using Windows installer
412390
~~~~~~~~~~~~~~~~~~~~~~~
413391

414-
There are separate graphical installers for 32 bit and 64 bit Windows systems
415-
with names in format ``robotframework-<version>.win32.exe`` and
416-
``robotframework-<version>.win-amd64.exe``, respectively. Newer installers
417-
are on PyPI_ and Robot Framework 2.8.1 and older on the old `Google Code
418-
download page`_. Running the installer requires double-clicking it and
419-
following the simple instructions.
420-
421-
Windows installers always run on Python and create the standard ``pybot`` and
422-
``rebot`` `runner scripts`_. Unlike the other provided installers, these
423-
installers also automatically create ``jybot`` and ``ipybot`` scripts. To be
424-
able to use the created runner scripts, both the :file:`Scripts` directory
425-
containing them and the appropriate interpreters need to be in PATH_.
426-
427-
Installing Robot Framework may require administrator privileges. In that case
428-
select `Run as administrator` from the context menu when starting the
429-
installer.
430-
431-
.. note:: Windows installers will no longer be created for upcoming Robot
432-
Framework 3.0. Please see `using pip`_ or `installing from source`_ for
433-
alternatives.
392+
Windows installers are no longer be created for Robot Framework 3.0 and later.
393+
Please see `using pip`_ or `installing from source`_ for alternatives.
434394

435395

436396
Standalone JAR distribution
@@ -447,17 +407,17 @@ with it like:
447407

448408
.. sourcecode:: bash
449409

450-
java -jar robotframework-2.9.jar mytests.robot
451-
java -jar robotframework-2.9.jar --variable name:value mytests.robot
410+
java -jar robotframework-3.0.jar mytests.robot
411+
java -jar robotframework-3.0.jar --variable name:value mytests.robot
452412

453413
If you want to `post-process outputs`_ using Rebot or use other built-in
454414
`supporting tools`_, you need to give the command name ``rebot``, ``libdoc``,
455415
``testdoc`` or ``tidy`` as the first argument to the JAR file:
456416

457417
.. sourcecode:: bash
458418

459-
java -jar robotframework-2.9.jar rebot output.xml
460-
java -jar robotframework-2.9.jar libdoc MyLibrary list
419+
java -jar robotframework-3.0.jar rebot output.xml
420+
java -jar robotframework-3.0.jar libdoc MyLibrary list
461421

462422
For more information about the different commands, execute the JAR without
463423
arguments.
@@ -492,13 +452,13 @@ interpreter versions as a result:
492452
.. sourcecode:: bash
493453

494454
$ pybot --version
495-
Robot Framework 2.9 (Python 2.7.10 on linux2)
455+
Robot Framework 3.0 (Python 2.7.10 on linux2)
496456

497457
$ rebot --version
498-
Rebot 2.9 (Python 2.7.10 on linux2)
458+
Rebot 3.0 (Python 2.7.10 on linux2)
499459

500460
$ jybot --version
501-
Robot Framework 2.9 (Jython 2.7 on java1.7.0_60)
461+
Robot Framework 3.0 (Jython 2.7 on java1.7.0_60)
502462

503463
If running the runner scripts fails with a message saying that the command is
504464
not found or recognized, a good first step is double-checking the PATH_
@@ -550,7 +510,8 @@ been done using some other approach.
550510
Uninstallation after using Windows installer
551511
''''''''''''''''''''''''''''''''''''''''''''
552512

553-
If `Windows installer`_ has been used, uninstallation can be done using
513+
If `Windows installer`_ was used to install an earlier version of Robot
514+
Framework, uninstallation can be done using
554515
`Control Panel > Add/Remove Programs`. Robot Framework is listed under
555516
Python applications.
556517

@@ -589,7 +550,7 @@ Runner scripts
589550
~~~~~~~~~~~~~~
590551

591552
Robot Framework has different runner scripts for executing test cases and for
592-
post-processing outputs based on earlier test results. Starting from upcoming
553+
post-processing outputs based on earlier test results. Starting from
593554
Robot Framework 3.0, the scripts are always the same regardless of the
594555
interpreter that was used for installation:
595556

0 commit comments

Comments
 (0)