Skip to main content

Robot Framework test library for transferring files via Secure Copy (SCP)

Project description

PyPI version PyPI license PyPI pyversions

Robot Framework test library for Secure Copy (SCP)

This library can be used to copy files to and from a remote machine using Secure Copy (SCP). It uses the Paramiko SSH Python library (just like robotframework-sshlibrary) and an SCP wrapper (‘scp’ by James Bardin).

The library does not currently support Jython or IronPython at this time.


This library may be installed via PyPI or from the source distribution. To install using pip, run:

pip install robotframework-scplibrary

To install from the source distribution, download the repo archive and extract the source and run:

python install


*** Settings ***
Library   SCPLibrary

*** Test Cases ***
Grab Files From My Server
    Open Connection    username=tyler  password=teapot
    Get File          remotefile.txt  localfile.txt
    Get File          /home/tyler/    mytylerdir/     recursive=True
    Close Connection

Put File On My Server
    Open Connection    username=tyler  password=teapot
    Put File          mytea.txt       /home/tyler/
    Close Connection


Before files can be transferred, a connection to remote machine must first be made. A connection can be made with the Open Connection keyword. Both normal username/password authentication and asymmetric key-pair authentication may be used.

Connections should be closed using the Close Connection keyword when they are no longer in use.

File transfer

Files and directories can be uploaded to the remote machine using the Put File or Put Directory keywords or downloaded to the local machine using the Get File keyword.

A connection must be made using the Open Connection keyword before file transfers may be made.

Project details

Download files

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

Source Distribution

robotframework-scplibrary-1.2.0.tar.gz (3.7 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page