Skip to main content

Advanced SFTP functions based on Paramiko

Project description

sftputil

Python High-level SFTP client library

Documentation is available on readthedocs, or in docs/index.md.

Description

sftputil is Python library to transfer files using SFTP. At this point only the API is available, but a command line will probably be added in the future.

Why this package?

  • Paramiko provides a SFTP client but it does not contain many methods. It is alright if one only needs simple get/put/list commands. But it is not enough for more complex operations.
  • pySFTP would have been the solution, but it has not been updated since 2016 (at the time of this writing). It is a dead project and cannot be improved. It does not manage the last SSH key algorithms.

Thus this new project. The initial reason was also that I needed a rsync-like command through SFTP in Python scripts.

Installation

Available on pypi.

pip install sftputil

Usage

TODO

Support

If you have any question or suggestion, you can open a new issue.

Roadmap

TODO for future releases:

  • Add synchronisation on the other direction (push)
  • Add a command line
  • Add some unit tests

Contributing

You are free to fork this repository and to do Merge Requests that I will review.

Authors and acknowledgment

Main author: Romain TAPREST romain@taprest.fr

License

Licensed under Mozilla Public License v2.

Project status

Alive! 💓

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

sftputil-1.2.1.tar.gz (11.1 kB view hashes)

Uploaded Source

Built Distribution

sftputil-1.2.1-py3-none-any.whl (18.0 kB view hashes)

Uploaded Python 3

Supported by

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