Metadata-Version: 2.1
Name: colab-sshfs
Version: 0.0.3
Summary: Mount sshfs remotes on Google Colaboratory
Home-page: https://github.com/bil/colab_sshfs
Author: Paul Nuyujukian
License: GPL2
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# colab_sshfs
## sshfs mounts for Google Colaboratory
[Google Colaboratory](http://research.google.com/colaboratory) is a free, fully-hosted fork off of a predecessor of [Jupyter](http://jupyter.org) available with a Google account.
While [mounting Google Drive](https://colab.research.google.com/notebooks/io.ipynb#scrollTo=Mounting_Google_Drive_locally) is straightforward, other storage spaces are not.
This package makes mounting [sshfs](https://github.com/libfuse/sshfs)-accessible remote spaces straightforward.

NOTE: Password-based authentication is not supported.

## Installation
Execute the following in a cell:

    !pip install colab_sshfs
## Usage
    from collab_sshfs import collab_sshfs
    collab_sshfs.mount(remote = '<user>@<host>:[remote path]')
By default, the local path mounted is `/content/sshfs`.
The mount function returns a [CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess) instance.


