Onedata Documentation

Guides, API references, and examples for building with Onedata.

Introduction User Guide Admin Guide Glossary Releases

OnedataRestFS (Python)

Table of Contents

In a nutshell

OnedataRESTFS is a PyFilesystem2 plugin for Onedata distributed file system based on Onedata REST API.

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, 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.

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 page.