Revision: cbb0c33ec9be
Author: anssi.syrjasalo <anssi.syrjas...@eficode.com>
Date: Mon Sep 30 09:17:09 2013 UTC
Log: Edited wiki page InstallationInstructions through web user
interface.
http://code.google.com/p/robotframework-sshlibrary/source/detail?r=cbb0c33ec9be&repo=wiki
Modified:
/InstallationInstructions.wiki
=======================================
--- /InstallationInstructions.wiki Thu Sep 26 14:10:17 2013 UTC
+++ /InstallationInstructions.wiki Mon Sep 30 09:17:09 2013 UTC
@@ -3,101 +3,73 @@
This guide explains how to install Robot Framework SSHLibrary on Linux and
Windows. The Linux parts likely work for other Unix-like systems (like OS
X) as well.
-The guide is divided into two major parts, depending on whether you are
using Python or Jython:
-<wiki:toc max_depth="2" />
+The guide is divided as following:
+<wiki:toc max_depth="3" />
-= Installation with Python =
+= Dependencies =
-== Dependencies ==
+== Python ==
-To use SSHLibrary with Python, a module named [http://www.lag.net/paramiko
Paramiko] is required, and additionally Paramiko has
[http://www.pycrypto.org PyCrypto] module as a dependency. Depending on the
operating system and the installation approach, you may need to install
these dependencies manually.
+To use SSHLibrary with Python, a module named [http://www.lag.net/paramiko
Paramiko] is required and Paramiko requires [http://www.pycrypto.org
PyCrypto] module as a dependency.
-== Linux ==
+=== Linux ===
-=== Using pip ===
+Depending on the [#Installation installation approaches] discussed further
below, Paramiko and PyCrypto may be installed automatically by SSHLibrary.
-If you have [http://pip-installer.org pip] available, the easiest way to
install SSHLibrary is to run:
-{{{
-pip install robotframework-sshlibrary
-}}}
+If you need to install them manually, you may use your distribution's
package manager, for example on Debian variants, running `sudo apt-get
install python-paramiko` should install them. If this is not possible, you
can install them using the source distributions from PyPI:
+ * PyCrypto: https://pypi.python.org/pypi/pycrypto
+ * Paramiko: https://pypi.python.org/pypi/paramiko
-This installation approach should take care of installing the dependencies
automatically.
+=== Windows ===
-=== Using source distributions ===
+On Windows you should always install PyCrypto using the
[http://www.voidspace.org.uk/python/modules.shtml#pycrypto binary
installer] *before* installing Paramiko. This is because installing
PyCrypto automatically would require a C compiler. Make sure you pick the
correct Paramiko installer depending on your Python version and CPU
architecture.
-If `pip` is not installed, SSHLibrary can be installed using the source
distribution:
+Like on Linux, Paramiko may be installed automatically by SSHLibrary, but
you can also install it yourself using the
[https://pypi.python.org/pypi/paramiko source distribution].
- # Download the source tar.gz at
https://code.google.com/p/robotframework-sshlibrary/downloads
- # Extract the package to a temporary location
- # Open a terminal
- # `cd` to the extracted directory
- # Run `python setup.py install` (or `sudo python setup.py install`) to
install system-wide)
+== Jython ==
-If you have [http://pythonhosted.org/setuptools/ setuptools] module (or
its now discontinued fork `distribute`) installed, also this installation
approach takes care of installing the dependencies. Otherwise you need to
install them manually. You can find both
[https://pypi.python.org/pypi/paramiko/ paramiko] and
[https://pypi.python.org/pypi/pycrypto PyCrypto] source distributions from
PyPI.
-
-== Windows ==
-
-=== Installing PyCrypto ===
-
-On Windows you need to install PyCrypto module before installing
SSHLibrary or paramiko. The absolutely easiest approach is getting a
[http://www.voidspace.org.uk/python/modules.shtml#pycrypto binary
installer]. Make sure you pick the correct installer depending on your
Python version and CPU architecture.
-
-=== Using pip ===
-
-If you have [http://pip-installer.org pip] available, the easiest way to
install SSHLibrary is to run:
-{{{
-pip install robotframework-sshlibrary
-}}}
+To use SSHLibrary with Jython, Trilead SSH library is required.
-This installation approach should take care of installing paramiko
automatically.
+Regardless of the operating system, you need to download
[http://search.maven.org/remotecontent?filepath=com/trilead/trilead-ssh2/1.0.0-build217/trilead-ssh2-1.0.0-build217.jar
Trilead SSH JAR distribution] and append its path to your CLASSPATH.
-=== Using source distributions ===
-If `pip` is not installed, SSHLibrary can be installed using the source
distribution:
+= Installation =
- # Download the source tar.gz at
https://code.google.com/p/robotframework-sshlibrary/downloads
- # Extract the package to a temporary location
- # Open a terminal
- # `cd` to the extracted directory
- # Run `python setup.py install`
+The easiest way to install SSHLibrary is using
[http://www.pip-installer.org pip package manager]. If you do not want to
install pip, or are using Jython which does not support it, you can always
install SSHLibrary using the source distribution.
-If you have [http://pythonhosted.org/setuptools/ setuptools] module (or
its now discontinued fork `distribute`) installed, also this installation
approach takes care of installing the dependencies. Otherwise you need to
install them manually. You can find both
[https://pypi.python.org/pypi/paramiko/ paramiko] and
[https://pypi.python.org/pypi/pycrypto PyCrypto] source distributions from
PyPI.
+== Using pip ==
-== Verifying the installation ==
+With `pip`, all you need to do is run the following command:
-To test that installation of SSHLibrary and its dependencies was
successful, you can rung the following command on the command prompt:
{{{
- python -c "import SSHlibrary"
+pip install robotframework-sshlibrary
}}}
-If you get no error messages, SSHLibrary is installed correctly.
-
-= Installation with Jython =
-
-To use SSHLibrary with Jython, Trilead SSH library is required because
Paramiko does not work with Jython.
-
-Download
[http://search.maven.org/remotecontent?filepath=com/trilead/trilead-ssh2/1.0.0-build217/trilead-ssh2-1.0.0-build217.jar
Trilead SSH JAR distribution] and append its path to your CLASSPATH.
+The benefit of using `pip` is that it should install the required
[#Dependencies dependencies] automatically. However, on Windows you need to
first install PyCrypto binaries before using `pip`.
-== Linux and Windows ==
+== Using source distribution ==
SSHLibrary can be installed from the source as following:
+
# Download the source tar.gz at
https://code.google.com/p/robotframework-sshlibrary/downloads
# Extract the package to a temporary location
- # Open a command prompt / terminal
+ # Open a terminal / command prompt
# `cd` to the extracted directory
- # Run `jython setup.py install`
+ # Run `python setup.py install` or `jython setup.py install`, depending
on which interpreter you are using
+
-The last command may require sudo (Unix-likes) or administrator (Windows)
privileges if Jython is installed system-wide.
+= Verifying installation =
-== Verifying the installation ==
+To test that the installation of SSHLibrary and its dependencies was
successful, run one of the following commands in a terminal / command
prompt.
-1. Start the interactive Jython interpreter from a command prompt /
terminal:
+When using Python:
{{{
-jython
+ python -c "import SSHlibrary"
}}}
-2. Type the following in the interpreter and press ENTER:
+When using Jython:
{{{
-import SSHLibrary
+ jython -c "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.
