• Preconditions
• Python
• wxPython
• Robot Framework
• Installation
• Installing from source
• Using Windows installer
• Using easy_install
• Start-up
• Running RIDE from mercurial clone

Preconditions

Python

RIDE runs only on the regular Python, not on Jython or Iron Python. Python 2.5 is the minimum version. Notice that similarly as Robot Framework, RIDE does not yet support Python 3.

Most other operating systems other than Windows have a recent enough Python installed by default. You can get Windows installers and plenty of other information from http://python.org. In OSX RIDE needs 32-bit Python.

wxPython

RIDE's GUI is implemented using wxPython toolkit. Version 2.8.6 or newer with Unicode support is required. The ANSI version is not supported.

In Ubuntu/GNOME recommended wxPython version is 2.8.10.0 or newer.

In Windows 7 recommended wxPython version is 2.8.11.0 or newer.

For more information, installation instructions, and download packages see http://wxpython.org. On Linux you should be able to install wxPython with your package manager (e.g. on Ubuntu with sudo apt-get install python-wxgtk2.8). On the latest OS X versions you should have suitable wxPython version automatically, but unfortunately all RIDE features don't yet work on that platform.

Robot Framework

Starting from RIDE 0.36, Robot Framework is bundled with RIDE. This means that RIDE is independent on the installed Robot Framework version and you don't actually even need to have Robot installed.

Installation

RIDE is distributed as separate installation packages for Windows and for other platforms, and these packages can be found from the download page.

Installing from source

1. Get the source distribution.
2. Extract it e.g. with command tar xzvf robotide-<version>.tar.gz.
3. Go to the created directory and run python setup.py install. Notice that you need to use sudo python setup.py install to install to everyone.

Using Windows installer

1. Get Windows installer
2. Double click the installer and click through the opened GUI.

Using easy_install

Starting from RIDE 0.31 you can install RIDE with command:

  easy_install robotframework-ride

The above command should always install the latest version. To get a specific version, you can use this version instead:

  easy_install robotframework-ride==0.31

This installation approach works on all operating systems but requires you to have setuptools installed. Notice that you may need to prefix the command with sudo on unixy machines.

Start-up

After a successful installation RIDE can be started from the command line with command:

   ride.py [inpath]

On Windows this requires having <PythonInstallationDir>\Scripts on PATH. If pybot and jybot commands work you should be fine, otherwise see instructions.

See UsageInstructions for more information about using RIDE.

Note:

The ride.py file will contain an incorrect shebang line in Windows. This will have effect only if you are trying to start RIDE in Windows from Cygwin. In that case, you will need to edit ride.py manually and insert path to correct Python.

Running RIDE from mercurial clone

Mercurial needs to be installed.

hg clone http://robotframework-ride.googlecode.com/hg/ robotframework-ride
cd robotframework-ride
python rundevel.py [datasource]

To update your clone, run hg pull -u