# OnedataRestFS (Python)

# In a nutshell

OnedataRESTFS is a PyFilesystem2 (opens new window) plugin for Onedata distributed file system based on Onedata REST API (opens new window).

As a PyFilesystem2 plugin implementation, OnedataRESTFS allows you to work with Onedata in the same way as any other filesystem supported by PyFilesystem2.

Supported Onezone versions: >= 21.02.5.

Supported Oneprovider versions: >= 21.02.5.

# Installation

OnedataRESTFS library can be installed directly from PyPi (opens new window), for example using pip:

pip install fs.onedatarestfs

NOTE

The package name fs.onedatarestfs is due to the convention of PyFilesystem2 plugins.

The source code is available on GitHub (opens new window).

NOTE

As an alternative to this library, we also provide a Python wrapper library supporting our binary data and metadata protocol — OnedataFS, which has better performance, however requires installation of several C++ dependencies.

# Usage

For reference documentation and usage examples see the GitHub (opens new window) page.