Revision: 5926df76ded6
Author: anssi.syrjasalo <anssi.syrjas...@eficode.com>
Date: Thu Sep 26 14:10:17 2013 UTC
Log: Edited wiki page InstallationInstructions through web user
interface.
http://code.google.com/p/robotframework-sshlibrary/source/detail?r=5926df76ded6&repo=wiki
Modified:
/InstallationInstructions.wiki
=======================================
--- /InstallationInstructions.wiki Wed Sep 18 12:27:46 2013 UTC
+++ /InstallationInstructions.wiki Thu Sep 26 14:10:17 2013 UTC
@@ -1,64 +1,72 @@
#summary How to install SSHLibrary step by step
#labels Featured
-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.
+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" />
= Installation with Python =
-To use SSHLibrary with Python, a library named
[http://www.lag.net/paramiko Paramiko] is required. Paramiko itself
requires [http://www.pycrypto.org PyCrypto] as a dependency which must be
installed before installing Paramiko.
+== Dependencies ==
-Installing these dependencies is documented below by operating system.
+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.
== Linux ==
-Both `pip` and `setup.py` should install the dependencies (packages
[https://pypi.python.org/pypi/robotframework robotframework],
[https://pypi.python.org/pypi/pycrypto/ pycrypto] and
[https://pypi.python.org/pypi/paramiko/ paramiko]) automatically but if
not, install them one by one in that order using `pip`.
-
=== Using pip ===
-If you have `pip` available, the easiest way to install SSHLibrary is to
run:
+If you have [http://pip-installer.org pip] available, the easiest way to
install SSHLibrary is to run:
{{{
pip install robotframework-sshlibrary
}}}
-=== Using setup.py ==
+This installation approach should take care of installing the dependencies
automatically.
-If pip is not available, SSHLibrary can be installed from source:
+=== Using source distributions ===
+
+If `pip` is not installed, SSHLibrary can be installed using the 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`
+ # Run `python setup.py install` (or `sudo python setup.py install`) to
install system-wide)
-The last command may require root privileges (`sudo python setup.py
install`) if Python is installed system-wide.
+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 ==
-1. Make sure you have
[https://code.google.com/p/robotframework/wiki/Installation Robot Framework
installed].
+=== Installing PyCrypto ===
-2. Download and run
[http://www.voidspace.org.uk/python/modules.shtml#pycrypto PyCrypto
binaries for Windows]. Make sure you pick the correct installer depending
on your Python version and CPU architecture.
+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.
-3. Install Paramiko from source as following:
- # Download the [https://github.com/paramiko/paramiko/archive/1.11.zip
Paramiko source distribution]
- # Unzip the package to a temporary location
- # Open a command prompt
+=== Using pip ===
+
+If you have [http://pip-installer.org pip] available, the easiest way to
install SSHLibrary is to run:
+{{{
+pip install robotframework-sshlibrary
+}}}
+
+This installation approach should take care of installing paramiko
automatically.
+
+=== Using source distributions ===
+
+If `pip` is not installed, SSHLibrary can be installed using the 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`
-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.
+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.
== 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:
+To test that installation of SSHLibrary and its dependencies was
successful, you can rung the following command on the command prompt:
{{{
-import SSHLibrary
+ python -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.
