Welcome to pysftp’s documentation!

A simple interface to sftp. based on zeth’s ssh.py

Example

import pysftp

with pysftp.Connection('hostname', username='me', password='secret') as sftp:
    with sftp.cd('public'):             # temporarily chdir to public
        sftp.put('/my/local/filename')  # upload file to public/ on remote
        sftp.get('remote_file')         # get a remote file

Supports

Tested on Python 2.7, 3.2, 3.3, 3.4

Additional Information

• Project: https://bitbucket.org/dundeemt/pysftp
• Download: https://pypi.python.org/pypi/pysftp
• Documentation: https://pysftp.rtfd.org/
• License: BSD

requirements

paramiko >= 1.15.2

Contents:

• Cook Book
  • pysftp.Connection()
  • pysftp.CnOpts
  • pysftp.Connection.get()
  • pysftp.Connection.get_d()
  • pysftp.Connection.get_r()
  • pysftp.Connection.put()
  • pysftp.Connection.put_d()
  • pysftp.Connection.put_r()
  • pysftp.Connection.cd()
  • pysftp.Connection.chmod()
  • pysftp.st_mode_to_int()
  • pysftp.Connection.chown()
  • pysftp.Connection.cwd()
  • pysftp.Connection.pwd
  • pysftp.Connection.listdir()
  • pysftp.Connection.listdir_attr()
  • pysftp.Connection.makedirs()
  • pysftp.Connection.mkdir()
  • pysftp.Connection.isdir()
  • pysftp.Connection.isfile()
  • pysftp.Connection.readlink()
  • pysftp.Connection.exists()
  • pysftp.Connection.lexists()
  • pysftp.Connection.truncate()
  • pysftp.Connection.walktree()
  • pysftp.Connection.sftp_client
  • pysftp.path_advance
  • pysftp.path_retreat
  • pysftp.reparent
  • pysftp.walktree
  • pysftp.cd
  • Remarks
• API
  • SFTPAttributes
  • SFTPFile
  • SecurityOptions
• Change Log
• Contributing
  • Code
  • Docs
  • Bug Reports
  • Issue Priorities
  • Testing
• Authors
  • Acknowledgment

Indices and tables

• Index
• Module Index
• Search Page