Skip to main content

simple, asynchronous sftp operations

Project description

RySftp

Why RySftp? Because PySftp was taken, and I'm selfish.

This is my first attempt at an SFTP client. It's current state should be considered alpha, and full of bugs. It barely works, and it still needs to be documented and more thoroughly tested. DON'T USE THIS RIGHT NOW. I've only published this package for testing, and to share with a few people.

RySftp is essentially a wrapper around some of the tried and true paramiko package's features, that aims to make SFTP usage in python quick and easy. The connection resource is managed via a context manager, accessed using with statements. RySftp also implements multithreaded upload and downloads over a single connection, dramatically improving transfer rates on large #s of files.

RySftp automatically searches for the below environment variables for connection information:

Variable Usage
RYSFTP_USER Username
RYSFTP_PASSWORD Password
RYSFTP_HOST Hostname
RYSFTP_PORT Port
RYSFTP_REMOTEDIR Default remote dir

Installation

Use the package manager pip to install RySftp.

pip install rysftp

Usage

RySftp aims to be simple. Here is a barebones usage example:

from rysftp import RySftp

ry = RySftp()
with ry("home/downloads"):
    ry.download_latest(100)
    ry.upload_latest(4)

Documentation

Documentation

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

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

RySftp-0.0.10.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

RySftp-0.0.10-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file RySftp-0.0.10.tar.gz.

File metadata

  • Download URL: RySftp-0.0.10.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.5

File hashes

Hashes for RySftp-0.0.10.tar.gz
Algorithm Hash digest
SHA256 8cf890c1699ce876e5221a5a705962be686fdbbcf2b8db2359519c03a9e2bfb5
MD5 cc01b7aec40b11af2ac06cecbc8a491a
BLAKE2b-256 142485bd32d481d3fffd6a16807d9b3a6e50d2ef1ece3bd0c13697d2242ddb0d

See more details on using hashes here.

File details

Details for the file RySftp-0.0.10-py3-none-any.whl.

File metadata

  • Download URL: RySftp-0.0.10-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.5

File hashes

Hashes for RySftp-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 091f4dba82e09bf02f461af3e77d211617a82af334ee08ce91afc48c1ecc9bec
MD5 261ba447140a5c5a47b785634c856c3c
BLAKE2b-256 db09dbd9677db7d995858c5a942068ae9be8ab5ca62233962f1c077e405690a7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page