Skip to main content

Simple way to handle sftp with python. Provides the ability to upload and download directories.

Installation

install the latest stable version using pip

$ pip install simple-sftp

Usage

from simple_sftp.client import Client

ip = < FTP SERVER IP >
user = < FTP LOGIN USER >
password = < FTP LOGIN PASSWORD > 
PORT = < FTP CONNECT PORT > # not required. default 22

c = Client(ip, user, password)

Functions

upload

A function that uploads a specific directories to ftp server.

remote_path = < FTP SERVER REMOTE DIR PATH >
local_path = < LOCAL DIR PATH >

upload(remote_path, local_path)

download

A function that downloads a specific directories to ftp server.

remote_path = < FTP REMOTE DIR PATH >
local_path = < LOCAL DIR PATH >

download(remote_path, local_path)

Use console scripts

simple-sftp-cli --ip < FTP SERVER IP > --user < FTP LOGIN USER > --pwd < FTP LOGIN PASSWORD > --local < LOCAL_DIR_PATH > --remote < FTP SERVER REMOTE DIR PATH >

Example

simple-sftp-cli --ip 123.456.789.123 --user user --pwd 1234 --local /home/user/abc --remote /home/my/abc

Third Party Libraries and Dependencies

Metadata

Release files for simple-sftp 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for simple-sftp 0.1.3
File Interpreter ABI Platform
simple_sftp-0.1.3-py3-none-any.whl Python 3 none any Details

Release files / simple_sftp-0.1.3-py3-none-any.whl

Download URL simple_sftp-0.1.3-py3-none-any.whl
Size 3.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6d004cbfc8ed8cb0b90095e141cd52170e8f17907fa984df7701f810ddf518a6
BLAKE2b-256 checksum
How to use checksums
e800cb6fc565ec5140a3211c8c86d359cd35b2fdf52572c426d028434ca4af1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release history Release notifications | RSS feed

This release

0.1.3 This release

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page