(CkPython) SCP Download Text File to String Variable

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable.

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

ssh = chilkat.CkSsh()

# Hostname may be an IP address or hostname:
hostname = "www.some-ssh-server.com"
port = 22

# Connect to an SSH server:
success = ssh.Connect(hostname,port)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Wait a max of 5 seconds when reading responses..
ssh.put_IdleTimeoutMs(5000)

# Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword")
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
scp = chilkat.CkScp()

success = scp.UseSsh(ssh)
if (success != True):
    print(scp.lastErrorText())
    sys.exit()

# This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
remotePath = "repository/xml/hamlet.xml"

# The byte representation of the remote text file (i.e. the charset) must be
# indicated to allow the receiving software to correctly interpret the incoming
# bytes as the correct chars.
# See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
charset = "utf-8"

fileContents = scp.downloadString(remotePath,charset)
if (scp.get_LastMethodSuccess() != True):
    print(scp.lastErrorText())
    sys.exit()

print("Received file:")
print(fileContents)

print("SCP download string success.")

# Disconnect
ssh.Disconnect()