Revision: b931087a0a78
Author: Anssi Syrjäsalo <anssi.syrjas...@eficode.com>
Date: Mon Sep 16 12:17:05 2013 UTC
Log: Improved installation instructions
http://code.google.com/p/robotframework-sshlibrary/source/detail?r=b931087a0a78&repo=wiki
Modified:
/InstallationInstructions.wiki
=======================================
--- /InstallationInstructions.wiki Mon Sep 16 10:53:26 2013 UTC
+++ /InstallationInstructions.wiki Mon Sep 16 12:17:05 2013 UTC
@@ -1,25 +1,29 @@
#summary How to install SSHLibrary step-by-step
+This guide explains how to install Robot Framework SSHLibrary on Linux and
Windows. The Linux parts likely work for other Unix-likes (like OS X) as
well.
+
+The guide is divided into two major parts depending on whether you are
using Python or Jython.
+
= Installation with Python =
-SSHLibrary requires Robot Framework to be installed. When using SSHLibrary
with Python, a library named [http://www.lag.net/paramiko Paramiko] is also
required. Paramiko itself requires [http://www.pycrypto.org PyCrypto
toolkit] as a dependency which must be installed before installing Paramiko.
+When using SSHLibrary with Python, a library named
[http://www.lag.net/paramiko Paramiko] is also required. Paramiko itself
requires [http://www.pycrypto.org PyCrypto toolkit] as a dependency which
must be installed before installing Paramiko.
Installing dependencies is documented below by operating system.
-== Linux & OS X ==
+== Linux ==
-The following approaches should install all the dependencies automatically.
+The following two approaches should install the dependencies
(packages 'robotframework', 'pycrypto' and 'paramiko') automatically but if
not, install them one by one using pip.
=== Using pip ===
-If you have pip available, the easiest way to install SSHLibrary is to run
the following:
+If you have pip available, the easiest way to install SSHLibrary is to run:
{{{
pip install robotframework-sshlibrary
}}}
=== Using setup.py ==
-If pip is not available, SSHLibrary can be installed from source as
following:
+If pip is not available, SSHLibrary can be installed from source:
# Download the source tar.gz at
https://code.google.com/p/robotframework-sshlibrary/downloads
# Extract the package to a temporary location
# Open a terminal
@@ -43,8 +47,24 @@
4. Download and run
[https://code.google.com/p/robotframework-sshlibrary/downloads/list
SSHLibrary binary for Windows]. Make sure you pick the correct installer
depending on your CPU architecture.
+== Verifying the installation ==
+
+1. Start the interactive Python interpreter from a command prompt /
terminal:
+{{
+python
+}}
+
+2. Type the following in the interpreter and press ENTER:
+{{
+import SSHLibrary
+}}
+
+If you get no error messages, SSHLibrary is installed correctly.
+
= Installation with Jython =
+SSHLibrary requires
+
When using SSHLibrary with Jython, Trilead SSH library is required as the
dependency. This is due to fact that Paramiko does not work with Jython.
Download
[http://robotframework-sshlibrary.googlecode.com/files/trilead-ssh2-build213.jar
Trilead SSH JAR distribution] and add it to your CLASSPATH.
@@ -59,3 +79,17 @@
# Run `jython setup.py install`
The last command may require sudo (Unix-likes) or administrator (Windows)
privileges if Jython is installed system-wide.
+
+== Verifying the installation ==
+
+1. Start the interactive Jython interpreter from a command prompt /
terminal:
+{{
+jython
+}}
+
+2. Type the following in the interpreter and press ENTER:
+{{
+import SSHLibrary
+}}
+
+If you get no error messages, SSHLibrary is installed correctly.
--
---
You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to robotframework-commit+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
