Revision: b7b7e58f6277
Author: Anssi Syrjäsalo <anssi.syrjas...@eficode.com>
Date: Mon Sep 16 10:15:07 2013 UTC
Log: Updated (installation) instructions
http://code.google.com/p/robotframework-sshlibrary/source/detail?r=b7b7e58f6277&repo=wiki
Modified:
/InstallationInstructions.wiki
/KeywordDocumentation.wiki
/ReleaseNotes.wiki
/RunningLibraryAcceptanceTests.wiki
=======================================
--- /InstallationInstructions.wiki Wed Jul 31 13:53:13 2013 UTC
+++ /InstallationInstructions.wiki Mon Sep 16 10:15:07 2013 UTC
@@ -1,37 +1,68 @@
+#summary How to install SSHLibrary step-by-step
#labels Featured
-<wiki:toc max_depth="3" />
-= Preconditions ==
+= Installation with Python =
-== When using 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.
-A precondition for using SSH Library with Python is having SSH module
named [http://www.lag.net/paramiko/ paramiko] installed. Paramiko itself
has some other requirements listed in installation instructions
(mainly !PyCrypto) and these must naturally be installed too. !PyCrypto
binaries for are available
[http://www.voidspace.org.uk/python/modules.shtml#pycrypto for Windows]
+Installing dependencies is documented below by operating system.
-In Windows, paramiko has to be installed from the source distribution, by
unzipping the download, and then running `python setup.py install` in the
unzipped directory.
+== Linux & OS X ==
-== When using Jython ==
+The following approaches should install all the dependencies automatically.
-Paramiko doesn't work with Jython, but
[http://robotframework-sshlibrary.googlecode.com/files/trilead-ssh2-build213.jar
Trilead SSH for Java] can be used instead. The JAR package containing
Trilead SSH tool must be found from the CLASSPATH during the test execution.
+=== Using pip ===
-See
[http://robotframework.googlecode.com/svn/trunk/doc/userguide/RobotFrameworkUserGuide.html#adjusting-library-search-path
Robot Framework user guide] for
-more information about setting the environment for test execution.
+If you have pip available, the easiest way to install SSHLibrary is to run
the following:
+ # pip install robotframework-sshlibrary
-= Installing SSH Library =
+=== Using setup.py ==
-SSH Library is installed differently on Windows and on other operating
systems.
+If pip is not available, SSHLibrary can be installed from source as
following:
+
+ # Download the source tar.gz at
https://code.google.com/p/robotframework-sshlibrary/downloads
+ # Extract the downloaded package to a temporary location
+ # Go to the extracted directory
+ # Run `python setup.py install`
+
+The last command may require root privileges (`sudo python setup.py
install`) if Python is installed system-wide.
== Windows ==
-Installing using Windows binary installer is really straightforward, just
-double click the
[http://code.google.com/p/robotframework-sshlibrary/downloads/list provided
Windows installer] and follow the instructions.
+1. Make sure you have Robot Framework installed
+
+This can be verified by running `pybot --version` in command prompt.
+
+2. Install PyCrypto binaries
+
+Download [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. Run the installer.
+
+3. Install Paramiko from source
+
+Download the [https://github.com/paramiko/paramiko/archive/1.11.zip
Paramiko source distribution]. Extract the package to a temporary location.
Open command prompt, browse into the folder (using `cd`)and run:
+
+ # python setup.py install
+
+Administrator privileges may be required if Python is installed
system-wide.
+
+4. Install SSHLibrary binaries
+
+Download [SSHLibrary binary for Windows
https://code.google.com/p/robotframework-sshlibrary/downloads/list]. Make
sure you pick the correct installer depending on your CPU architecture. Run
the installer.
+
+= Installation with Jython =
+
+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] and add it to your CLASSPATH.
-== Other operating systems ==
+== Installing from source ==
-On other operating systems SSH Library must be installed using a
[http://code.google.com/p/robotframework-sshlibrary/downloads/list source
distribution]. The procedure is following:
+SSHLibrary is installed as following:
- # Extract the source distribution package
- # Open console and go the resulting directory
- # Run command `python setup.py install`
+ # Download the source tar.gz at
https://code.google.com/p/robotframework-sshlibrary/downloads
+ # Extract the downloaded package to a temporary location
+ # Go to the extracted directory
+ # Run command `jython setup.py install`
-Root privileges may be required for the installation.
+The last command may require sudo (Unix-likes) or administrator (Windows)
privileges if Jython is installed system-wide.
=======================================
--- /KeywordDocumentation.wiki Thu Aug 1 16:28:17 2013 UTC
+++ /KeywordDocumentation.wiki Mon Sep 16 10:15:07 2013 UTC
@@ -1,15 +1,15 @@
-#summary Keyword documentation by version
+#summary Keyword documentation by release
#labels Featured
-= Taking Library into use =
+= Taking SSHLibrary into use =
-To use SSHLibrary into use in a test suite, add following in the settings
table:
+To use SSHLibrary in your tests, add the following line to the settings
table of your test suite:
|| Library || SSHLibrary ||
-SSHLibrary import also takes some arguments, these are documented in the
keyword documentation.
+The library import allows some arguments which are documented in keyword
documentation.
-= Keyword documentation by version =
+= Keyword documentation by release =
*
[https://robotframework-sshlibrary.googlecode.com/git-history/1.1/doc/SSHLibrary.html
Version 1.1]
*
[https://robotframework-sshlibrary.googlecode.com/git-history/1.0/doc/SSHLibrary.html
Version 1.0]
=======================================
--- /ReleaseNotes.wiki Tue Jun 18 12:19:45 2013 UTC
+++ /ReleaseNotes.wiki Mon Sep 16 10:15:07 2013 UTC
@@ -1,4 +1,6 @@
-#labels Featured
+#summary Release notes for all the SSHLibrary releases
+#labels Featured
+
== SSHLibrary 1.1 ==
SSHLibrary 1.1 was released on Friday the 31st of August, 2012.
=======================================
--- /RunningLibraryAcceptanceTests.wiki Wed Aug 21 12:25:28 2013 UTC
+++ /RunningLibraryAcceptanceTests.wiki Mon Sep 16 10:15:07 2013 UTC
@@ -1,4 +1,4 @@
-#summary How to setup environment and run SSHLibrary's own acceptance
tests.
+#summary How to run SSHLibrary's own acceptance tests
Because SSHLibrary is primary used on Linux, it's highly recommended to
run the tests on a Linux host, e.g. on a dedicated virtual machine.
@@ -36,10 +36,10 @@
== Running the acceptance tests ==
-There's a shell script `atest/run_test.sh` which runs all the tests,
either with pybot or jybot:
+There's a bash script `atest/run_atests.sh` which runs all the tests
either with pybot or jybot as following:
{{{
atest/run_atests.sh python atest/ # Run all tests with pybot
atest/run_atests.sh jython atest/ # Run all tests with jybot
}}}
-The script also accepts normal Robot Framework command line options, so
suites and tests can be filtered.
+The script also accepts standard Robot Framework command line options.
--
---
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.
