fs.sshfs 0.2.1

Pyfilesystem2 implementation for SSH/SFTP using paramiko

Requirements

pyfilesystem2
six
paramiko

Installation

Install directly from PyPI, using pip

pip install fs.sshfs

Usage

Use fs.open_fs to open a filesystem with an SSH FS URL:

import fs
my_fs = fs.open_fs("ssh://user:password@host:port/resource")

with the following optional parts:

• user: defaults to the current user

• password: if none provided, passwordless authentification methods are used (either using public keys or no authentification to connect to the host)

• port: defaults to the usual SSH port (port 22)

• resource: defaults to the root directory ("/")

For a more granular way of connecting to an SSH server, use the fs.sshfs.SSHFS constructor, which signature is:

from fs.sshfs import SSHFS
my_fs = SSHFS(
  host,            # The name or adress of the SSH server
  user=None,       # an optional username, defaults to the current user
  passwd=None,     # an optional password, not needed if using a public key or
                   #   an SSH server without authentification
  pkey=None,       # a `paramiko.PKey` object, used to connect with a
                   #   specific key (undiscoverable key, etc.)
  timeout=10,      # The timeout of the connection, in seconds
                   #   (None to disable)
  port=22,         # The port to which to connect, default to default SSH port
  keepalive=10,    # The interval of time between keepalive packets, in
                   #    seconds (0 to disable)
  compress=False   # Compress the communications with the server
)

Once created, the SSHFS filesystem behaves like any other filesystem (see the Pyfilesystem2 documentation)

See also

• fs, the core pyfilesystem2 library

• fs.archive, enhanced archive filesystems for pyfilesystem2

• fs.proxy, miscellaneous proxy filesystems for pyfilesystem2