Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
RIDE runs only on the regular Python, not on Jython nor IronPython. Python 2.6 is the minimum version. Notice that similarly as Robot Framework, RIDE does not yet support Python 3. Notice also that on OS X RIDE requires 32-bit Python version.
Most other operating systems than Windows have a recent enough Python installed by default. You can find Windows installers and plenty of other information from http://python.org.
RIDE's GUI is implemented using wxPython toolkit. Only wxPython 22.214.171.124 with Unicode support is officially supported. Possible new releases in wxPython 2.8 series ought to work fine too. wxPython 3.0 support is one of the priorities for future development.
On Linux you should be able to install wxPython with your package manager. For example, on Debian based systems such as Ubuntu running
sudo apt-get install python-wxgtk2.8 ought to be enough.
On OS X you should use wxPython binaries found from the wxPython download page. wxPython2.8 only has 32 bit build available, so Python must be run in 32-bit mode also. This can be done globally by running:
> defaults write com.apple.versioner.python Prefer-32-Bit -bool yes
or just for the RIDE execution:
> VERSIONER_PYTHON_PREFER_32_BIT=yes ride.py
Directories added to PATH as part of the Robot Framework installation must not contain quotes. Otherwise RIDE may not be able to execute tests due to a bug in Python.
RIDE is distributed as separate installation packages for Windows and for other platforms, and these packages can be found from the download page.
- Get the source distribution.
- Extract it e.g. with WinZip on Windows or with
tar xzvf robotframework-ride-<version>.tar.gzon Linux or OS X.
- Go to the created directory and run
python setup.py install. Notice that on Linux or OS X you typically need to prefix the command with
- Get Windows installer.
- Double click the installer and click through the opened GUI.
pip install robotframework-ride easy_install robotframework-ride
This installation approach works on all operating systems but obviously requires you to have
easy_install installed. Notice that you may need to prefix the above commands with
sudo on unixy machines.
After a successful installation RIDE can be started from the command line by running
ride.py. Alternatively you can specify a file or directory to open as an argument like
Starting from RIDE 0.54, you can also create a desktop shortcut during installation on Windows.
On Windows running
ride.py requires having
<PythonInstallationDir>\Scripts on PATH. If pybot command to run tests with Robot Framework works you should be fine. If it does not, see
Robot Framework installation instructions for more information about setting PATH.
If you use Cygwin on Windows, you may need to fix the shebang line in ride.py manually before running it.
To test the latest enhancements or fixes, you can easily checkout the latest RIDE sources from its version control system and run it directly from there. As a precondition you need to have Git and Invoke installed. After that, just run the following commands to clone RIDE's repository and start the latest version:
git clone https://github.com/robotframework/RIDE.git cd RIDE invoke devel [datasource]
To update your clone, run
git pull in the RIDE directory.
You may see what options invoke provides with:
invoke --help Usage: inv[oke] [--core-opts] task1 [--task1-opts] ... taskN [--taskN-opts] Core options: --complete Print tab-completion candidates for given parse remainder. --hide=STRING Set default value of run()'s 'hide' kwarg. --no-dedupe Disable task deduplication. --write-pyc Enable creation of .pyc files. -c STRING, --collection=STRING Specify collection name to load. -d, --debug Enable debug output. -e, --echo Echo executed commands before running. -f STRING, --config=STRING Runtime configuration file to use. -h [STRING], --help[=STRING] Show core or per-task help and exit. -l, --list List available tasks. -p, --pty Use a pty when executing shell commands. -r STRING, --root=STRING Change root directory used for finding task modules. -V, --version Show version and exit. -w, --warn-only Warn, instead of failing, when shell commands fail.
These are the possible tasks for our RIDE project:
invoke --list Available tasks: clean Clean bytecode files and remove `dist` and `build` directories. deps Fetch and install development dependencies. devel Start development version of RIDE. generate_big_project Generate big test data project to help perf testing. install Install development version and dependencies. random_test Use rtest go_find_bugs.py to randomly test RIDE API. register Register current version to Python package index. release_notes Download and format issues in markdown format. sdist Creates source distribution with bundled dependencies. test Run unit tests. update_robot Update robot framework to specified commit or tag. version Set `version.py` to given version. wininst Creates Windows installer with bundled dependencies.
Current version of invoke is:
invoke --version Invoke 0.12.2