| Name | sftpretty JSON |
| Version |
1.1.6
JSON |
| download |
| home_page | None |
| Summary | Pretty secure file transfer made easy. |
| upload_time | 2024-10-12 09:01:35 |
| maintainer | None |
| docs_url | None |
| author | byteskeptical |
| requires_python | >=3.6 |
| license | BSD 3-Clause License Copyright (c) 2021, byteskeptical All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
file-transfer
file-transfer-protocol
ftp
paramiko
pysftp
scp
sftp
sftp-client
sftp-download
sftp-server
sftp-upload
ssh
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
sftpretty
=========
A pretty quick and simple interface to paramiko SFTP. Provides multi-threaded
routines with progress notifications for reliable, asynchronous transfers. A
Python3 optimized fork of pysftp with additional features & improvements.
* Built-in retry decorator
* Hash function for integrity checking
* Improved local & remote directory mapping
* Improved logging mechanism
* More tests
* Multi-threaded directory transfers
* OpenSSH config file support
* Progress notifications
* Support for ciphers, compression, digests, kex & key type options
* Support for disabled algorithms
* Support for ED25519 & ECDSA keys
* Support for private key passwords
* Thread-safe connection manager
* Transfer Resumption
Example
-------
.. code-block:: python
from sftpretty import CnOpts, Connection
# Basic
with Connection('hostname', username='me', password='secret') as sftp:
# Temporarily chdir to public/.
with sftp.cd('public'):
# Upload file to public/ on remote.
sftp.put('/my/local/filename')
# Download a remote file from public/.
sftp.get('remote_file')
with Connection('hostname', private_key='~/.ssh/id_ed25519',
private_key_pass='secret') as sftp:
# Upload local directory to remote_directory.
sftp.put_d('/my/local', '/remote_directory')
# Recursively download a remote_directory and save it to /tmp locally.
sftp.get_r('remote_directory', '/tmp')
# Advanced
# Use password authentication
with Connection('hostname', username='me', password='secret') as sftp:
# Upload local directory to remote_directory. On occurance of any
# exception or child of, passed in the tuple, retry the operation.
# Between each attempt increment a pause equal to backoff * delay.
# Run a total of tries (six) times including the first attempt.
sftp.put_d('/my/local', '/remote_directory', backoff=2, delay=1,
exceptions=(NoValidConnectionsError, socket.timeout,
SSHException), tries=6)
# Use public key authentication
with Connection('hostname', private_key='~/.ssh/id_ed25519') as sftp:
# Resume the download of a bigfile and save it to /mnt locally.
sftp.get('bigfile', '/mnt', preserve_mtime=True, resume=True)
# Use public key authentication with optional private key password
with Connection('hostname', private_key='~/.ssh/id_ed25519',
private_key_pass='secret') as sftp:
# Recursively download a remote_directory and save it to /tmp locally.
# Don't confirm files, useful in a scenario where the server removes
# the remote file immediately after download. Preserve remote mtime on
# local copy. Limit the thread pool connections to the server.
sftp.get_r('remote_directory', '/tmp', confirm=False,
preserve_mtime=True, workers=6)
# Use OpenSSH config for public key authentication. Configuration
# connection values are prioritized when available. Credentials still need
# to be provided. There may be a significant delta between your ssh program
# and support for newer security option algorithms due to lagging support
# in paramiko.
cnopts = CnOpts(config='~/.ssh/config', knownhosts='server.pub')
with Connection('alias', cnopts=cnopts, private_key_pass='secret') as sftp:
# Rename existing file on remote server
sftp.rename('/remote/old_name', '/remote/new_name')
# Pass custom host key file for verification
cnopts = CnOpts(knownhosts='sftpserver.pub')
# Use connection options to set preferred encryption standards
cnopts.ciphers= ('aes256-ctr', 'aes128-ctr')
cnopts.digests = ('hmac-sha2-512', 'hmac-sha2-256')
cnopts.kex = ('ecdh-sha2-nistp521', 'ecdh-sha2-nistp384')
cnopts.key_types = ('ssh-ed25519', 'ecdsa-sha2-nistp521')
# Turn on verbose logging and set custom log file
cnopts.log = '/var/log/backups/daily.log'
cnopts.log_level = 'debug'
# Pass options object directly to connection object
with Connection('hostname', cnopts=cnopts, private_key='~/.ssh/id_backup',
private_key_pass='secret') as sftp:
# Aggressively retry important operation
sftp.put_r('/local_backup', '/remote_backup', backoff=2, delay=1,
exceptions=socket.timeout, preserve_mtime=True, tries=11)
+-------------------+--------------------------+
| API Diff |
+-------------------+--------------------------+
| pysftp | sftpretty |
+===================+==========================+
| cwd | cd [#]_ |
+-------------------+--------------------------+
| makedirs | mkdir_p |
+-------------------+--------------------------+
| walktree | {local,remote}tree [#]_ |
+-------------------+--------------------------+
.. [#] cwd() is a synonym for chdir(), use cd it's shorter and does the same thing.
.. [#] Connection.walktree & sftp.walktree with explicit naming.
.. [*] [path_advance, path_retreat, reparent] no longer needed.
Additional Information
----------------------
* Documentation: https://docs.sftpretty.com
* Download: https://pypi.python.org/pypi/sftpretty
* License: BSD
* Project: https://github.com/byteskeptical/sftpretty
Requirements
------------
paramiko >= 1.17.0
Supports
--------
Tested on Python 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12
Raw data
{
"_id": null,
"home_page": null,
"name": "sftpretty",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "file-transfer, file-transfer-protocol, ftp, paramiko, pysftp, scp, sftp, sftp-client, sftp-download, sftp-server, sftp-upload, ssh",
"author": "byteskeptical",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/dc/5f/b32ea9876080406f005c6152c21081660ecd21a60c91dcc5d26255cb1375/sftpretty-1.1.6.tar.gz",
"platform": null,
"description": "sftpretty\n=========\n\nA pretty quick and simple interface to paramiko SFTP. Provides multi-threaded\nroutines with progress notifications for reliable, asynchronous transfers. A\nPython3 optimized fork of pysftp with additional features & improvements.\n\n* Built-in retry decorator\n* Hash function for integrity checking\n* Improved local & remote directory mapping\n* Improved logging mechanism\n* More tests\n* Multi-threaded directory transfers\n* OpenSSH config file support\n* Progress notifications\n* Support for ciphers, compression, digests, kex & key type options\n* Support for disabled algorithms\n* Support for ED25519 & ECDSA keys\n* Support for private key passwords\n* Thread-safe connection manager\n* Transfer Resumption\n\n\nExample\n-------\n.. code-block:: python\n\n from sftpretty import CnOpts, Connection\n\n\n # Basic\n\n with Connection('hostname', username='me', password='secret') as sftp:\n # Temporarily chdir to public/.\n with sftp.cd('public'):\n # Upload file to public/ on remote.\n sftp.put('/my/local/filename')\n # Download a remote file from public/.\n sftp.get('remote_file')\n\n\n with Connection('hostname', private_key='~/.ssh/id_ed25519',\n private_key_pass='secret') as sftp:\n # Upload local directory to remote_directory.\n sftp.put_d('/my/local', '/remote_directory')\n\n # Recursively download a remote_directory and save it to /tmp locally.\n sftp.get_r('remote_directory', '/tmp')\n\n\n # Advanced\n\n # Use password authentication\n with Connection('hostname', username='me', password='secret') as sftp:\n # Upload local directory to remote_directory. On occurance of any\n # exception or child of, passed in the tuple, retry the operation.\n # Between each attempt increment a pause equal to backoff * delay.\n # Run a total of tries (six) times including the first attempt.\n sftp.put_d('/my/local', '/remote_directory', backoff=2, delay=1,\n exceptions=(NoValidConnectionsError, socket.timeout,\n SSHException), tries=6)\n\n\n # Use public key authentication\n with Connection('hostname', private_key='~/.ssh/id_ed25519') as sftp:\n # Resume the download of a bigfile and save it to /mnt locally.\n sftp.get('bigfile', '/mnt', preserve_mtime=True, resume=True)\n\n\n # Use public key authentication with optional private key password\n with Connection('hostname', private_key='~/.ssh/id_ed25519',\n private_key_pass='secret') as sftp:\n # Recursively download a remote_directory and save it to /tmp locally.\n # Don't confirm files, useful in a scenario where the server removes\n # the remote file immediately after download. Preserve remote mtime on\n # local copy. Limit the thread pool connections to the server.\n sftp.get_r('remote_directory', '/tmp', confirm=False,\n preserve_mtime=True, workers=6)\n\n\n # Use OpenSSH config for public key authentication. Configuration\n # connection values are prioritized when available. Credentials still need\n # to be provided. There may be a significant delta between your ssh program\n # and support for newer security option algorithms due to lagging support\n # in paramiko.\n cnopts = CnOpts(config='~/.ssh/config', knownhosts='server.pub')\n with Connection('alias', cnopts=cnopts, private_key_pass='secret') as sftp:\n # Rename existing file on remote server\n sftp.rename('/remote/old_name', '/remote/new_name')\n\n\n # Pass custom host key file for verification \n cnopts = CnOpts(knownhosts='sftpserver.pub')\n # Use connection options to set preferred encryption standards\n cnopts.ciphers= ('aes256-ctr', 'aes128-ctr')\n cnopts.digests = ('hmac-sha2-512', 'hmac-sha2-256')\n cnopts.kex = ('ecdh-sha2-nistp521', 'ecdh-sha2-nistp384')\n cnopts.key_types = ('ssh-ed25519', 'ecdsa-sha2-nistp521')\n # Turn on verbose logging and set custom log file\n cnopts.log = '/var/log/backups/daily.log'\n cnopts.log_level = 'debug'\n # Pass options object directly to connection object\n with Connection('hostname', cnopts=cnopts, private_key='~/.ssh/id_backup',\n private_key_pass='secret') as sftp:\n # Aggressively retry important operation\n sftp.put_r('/local_backup', '/remote_backup', backoff=2, delay=1,\n exceptions=socket.timeout, preserve_mtime=True, tries=11)\n\n\n+-------------------+--------------------------+\n| API Diff |\n+-------------------+--------------------------+\n| pysftp | sftpretty |\n+===================+==========================+\n| cwd | cd [#]_ |\n+-------------------+--------------------------+\n| makedirs | mkdir_p |\n+-------------------+--------------------------+\n| walktree | {local,remote}tree [#]_ |\n+-------------------+--------------------------+\n\n.. [#] cwd() is a synonym for chdir(), use cd it's shorter and does the same thing.\n.. [#] Connection.walktree & sftp.walktree with explicit naming.\n.. [*] [path_advance, path_retreat, reparent] no longer needed.\n\n\nAdditional Information\n----------------------\n* Documentation: https://docs.sftpretty.com\n* Download: https://pypi.python.org/pypi/sftpretty\n* License: BSD\n* Project: https://github.com/byteskeptical/sftpretty\n\nRequirements\n------------\nparamiko >= 1.17.0\n\nSupports\n--------\nTested on Python 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2021, byteskeptical All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Pretty secure file transfer made easy.",
"version": "1.1.6",
"project_urls": {
"Documentation": "https://docs.sftpretty.com",
"Repository": "https://github.com/byteskeptical/sftpretty",
"Tracker": "https://github.com/byteskeptical/sftpretty/issues"
},
"split_keywords": [
"file-transfer",
" file-transfer-protocol",
" ftp",
" paramiko",
" pysftp",
" scp",
" sftp",
" sftp-client",
" sftp-download",
" sftp-server",
" sftp-upload",
" ssh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33b2944c3355b1cdc05e0a4afcad38fe626f9f2a63093d65decdb59b88e3df64",
"md5": "845ca512d98ca8b3eb627a7852886cb7",
"sha256": "e6b18d53ad3b1070f4b54aa6c58d14a4a6bd4d05c964565e8df2c27fb0f38a0f"
},
"downloads": -1,
"filename": "sftpretty-1.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "845ca512d98ca8b3eb627a7852886cb7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 20282,
"upload_time": "2024-10-12T09:01:34",
"upload_time_iso_8601": "2024-10-12T09:01:34.202341Z",
"url": "https://files.pythonhosted.org/packages/33/b2/944c3355b1cdc05e0a4afcad38fe626f9f2a63093d65decdb59b88e3df64/sftpretty-1.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc5fb32ea9876080406f005c6152c21081660ecd21a60c91dcc5d26255cb1375",
"md5": "fccf3fc0e95e776963cee8bc058a0685",
"sha256": "9c876ecd90ce29fbb2270dd24c031fe454e5f73f4c7d5f94fcc578ad32a3a94c"
},
"downloads": -1,
"filename": "sftpretty-1.1.6.tar.gz",
"has_sig": false,
"md5_digest": "fccf3fc0e95e776963cee8bc058a0685",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 30651,
"upload_time": "2024-10-12T09:01:35",
"upload_time_iso_8601": "2024-10-12T09:01:35.913882Z",
"url": "https://files.pythonhosted.org/packages/dc/5f/b32ea9876080406f005c6152c21081660ecd21a60c91dcc5d26255cb1375/sftpretty-1.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 09:01:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "byteskeptical",
"github_project": "sftpretty",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sftpretty"
}
