Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Robot Framework test library for SSH and SFTP

Project description


SSHLibrary is a Robot Framework test library for testing SSH and SFTP. It is operating system independent and works both with Python and Jython.

The library has the following main usages:

  • Executing commands on the remote machine, either with blocking or non-blocking behavior.
  • Writing and reading in an interactive shell.
  • Transferring files and directories over SFTP.
  • Ensuring that files and directories exist on the remote machine.

SSHLibrary is open source software licensed under Apache License 2.0.


When installing SSHLibrary on UNIX-like machines with Python, the easiest approach is using pip:

pip install robotframework-sshlibrary

Alternatively you can download the source distribution from PyPI, extract it, and install it using one of the following depending are you using Python or Jython:

python install
jython install

A benefit of using pip is that it automatically installs paramiko and PyCrypto modules that SSHLibrary requires on Python. Using pip on Windows with Python works too, but you need to first install PyCrypto module manually.

On Jython SSHLibrary requires Trilead SSH JAR distribution.

For more detailed installation instructions see INSTALL.rst.


Keyword documentation by version can be found from

For general information about using test libraries with Robot Framework, see Robot Framework User Guide.

Project details

Release history Release notifications

This version
History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
robotframework_sshlibrary_py3-2.1.4.dev0-py3-none-any.whl (36.4 kB) Copy SHA256 hash SHA256 Wheel py3 Aug 15, 2017
robotframework-sshlibrary-py3-2.1.4.dev0.tar.gz (93.2 kB) Copy SHA256 hash SHA256 Source None Aug 15, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page