ftpretty

A wrapper for simple FTP operations: get, put, list etc.

The goal of this library is to provide a frictionless experience to FTPing files in way similar to Amazon's s3cmd command line tool. The API should be intuitive with the order of arguments reflecting the transfer direction of bytes.

Transfers are assumed to be binary.

Unrecognized commands fall through to the underlying FTP or FTP_TLS connection object

Supports python 2 & 3, tested on 2.7 & 3.5, 3.6, & 3.7

Examples

fromftprettyimportftpretty# Minimalf=ftpretty(host, user, pass)
# Advanced# kwargs are passed to underlying FTP or FTP_TLS connection# secure=True argument switches to an FTP_TLS connection default is False# passive=False disable passive connection, True is the default# Note: port is not supported as an argument in underlying FTP or FTP_TLS but support for# handling port has been internally added in ftpretty by setting FTP.port or FTP_TLS.portf=ftpretty(host, user, pass, secure=True, passive=False, timeout=10, port=2121)
# Get a file, save it locallyf.get('someremote/file/on/server.txt', '/tmp/localcopy/server.txt')
# Get a file and write to an open filemyfile=open('/tmp/localcopy/server.txt', 'wb')
f.get('someremote/file/on/server.txt', myfile)
# Get a file and return contents (in python 3 contents is bytes)contents=f.get('someremote/file/on/server.txt')
# Get a tree on a remote directory (similar to shutil.copytree, without following symlinksf.get_tree("/remote/tree/on/server", "/tmp/local/tree")
# Put a local file to a remote location# non-existent subdirectories will be created automaticallyf.put('/tmp/localcopy/data.txt', 'someremote/file/on/server.txt')
# Put a local file into a remote directory, denoted by trailing slash on remotef.put('/tmp/localcopy/data.txt', 'someremote/dir/')
# Put using an open file desciptormyfile=open('/tmp/localcopy/data.txt', 'r')
f.put(myfile, 'someremote/file/on/server.txt')
# Put using string data (in python 3 contents should be bytes)f.put(None, 'someremote/file/greeting.txt', contents='blah blah blah')
# Put a tree on a remote directory (similar to shutil.copytree, without following symlinksf.put_tree("Local/tree", "/remote/files/server")
# Return a list the files in a directoryf.list('someremote/folder')
['a.txt', 'b.txt']
f.list('someremote/folder', extra=True)
[{'date': 'Feb 11',
'datetime': datetime.datetime(2014, 2, 11, 2, 3),
'directory': 'd',
'group': '1006',
'items': '3',
'name': 'a.txt',
'owner': '1005',
'perms': 'rwxr-xr-x',
'size': '4096',
'time': '02:03',
'year': '2014'},
{'date': 'Feb 11',
'datetime': datetime.datetime(2014, 2, 11, 2, 35),
'directory': 'd',
'group': '1006',
'items': '3',
'name': 'b.txt',
'owner': '1005',
'perms': 'rwxr-xr-x',
'size': '4096',
'time': '02:35',
'year': '2014'}]
# Change to remote directoryf.cd('someremote/folder')
# Create directoryf.mkdir('new_folder')
# Delete a remote filef.delete('someremote/folder/file.txt')
# Close the connectionf.close()