scrippy_remote

SSH/SFTP/FTP client for the Scrippy framework.

Prerequisites

Python modules

List of necessary modules

The modules listed below will be automatically installed.

• paramiko
• pysmb

Installation

Manual

git clone https://codeberg.org/scrippy/scrippy-remote.git
cd scrippy-remote
python -m pip install -r requirements.txt
make install

With pip

pip install scrippy-remote

Usage

scrippy_remote

This module offers all the objects, methods, and functions for operations on remote hosts accessible via SSH/SFTP or FTP and a limited support of CIFS:

• Execution of commands on a remote host
• Copying directories/files to a remote host
• Deleting directories/files on a remote host
• Copying files between remote hosts (with the local machine acting as a buffer)
• ...

The scrippy_remote module provides several objects for transferring files via SFTP, FTP, FTPS, or CIFS, and for remote command execution via SSH.

The source code for the scrippy_remote.remote module and its sub-modules is also extensively commented and remains the best source of documentation.

A HTML version of the documentation can be generated using sphinx:

pip3 install sphinx
cd scrippy-remote
make doc

The resulting documentation will be generated in the docs/build/html directory.

Local operations

Each of the Ssh, Ftp, Cifs classes comes with some helper functions to operate on the local host such as :

• List a local directory content with a pattern filter
• Delete a local file
• Delete a local directory recursively

SSH/SFTP Operations

The Ssh class provides specific methods to execute commands and handle files and directory handling such as :

• Execute a command on a remote host
• Retrieve a remote file
• Mirror a remote directory to a local directory
• Transfer a file to a remote host
• Mirror a local directory to a remote directory
• List remote directory content
• Delete a remote file
• Delete a remote directory recursively

FTP

The Ftp class provides specific methods to execute commands and handle files and directory handling such as :

• Retrieve a remote file
• Mirror a remote directory to a local directory
• Transfer a file to a remote host
• Mirror a local directory to a remote directory
• List remote directory content
• Delete a remote file
• Delete a remote directory recursively

CIFS

The Cifs class provides specific methods to transfer files using the CIFS/Samba protocol such as:

• Retrieve a remote file
• Transfer a file to a remote host
• Open a file in write mode
• Open a file in read mode
• Delete remote directory content