"Client SSH, SFTP et FTP pour le cadriciel Scrippy."
Project description
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:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for scrippy_remote-3.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87320cfc125fbb217a917f64b93bc8f2e789b353ad792e4555294b7e13ecaf26 |
|
MD5 | 45a345e12159d0514d860243f634ffb3 |
|
BLAKE2b-256 | e259761927733d14dc53ce01d05ddd07c615a1260ca356eeb3e49170acb137cc |