fs.onedatarestfs 21.2.4rc2

Onedata REST-based filesystem for PyFilesystem

OnedataRESTFS

OnedataRESTFS is a PyFilesystem interface to Onedata virtual file system based on Onedata REST API.

As a PyFilesystem concrete class, OnedataRESTFS allows you to work with Onedata in the same way as any other supported filesystem.

Installing

You can install OnedataRESTFS from pip as follows:

pip install onedatarestfs

Opening a OnedataRESTFS

Open an OnedataRESTFS by explicitly using the constructor:

from fs.onedatarestfs import OnedataRESTFS
onedata_onezone_host = "..."
onedata_access_token = "..."
odfs = OnedataRESTFS(onedata_onezone_host, onedata_access_token)

Or with a FS URL:

  from fs import open_fs
  odfs = open_fs('onedatarestfs://HOST?token=...')

Optionally, OnedataRESTFS constructs accepts a list of preferred Oneprovider hosts, which should be selected if they support a specific Onedata space, e.g.:

from fs.onedatarestfs import OnedataRESTFS
onedata_onezone_host = "..."
onedata_access_token = "..."
odfs = OnedataRESTFS(onedata_onezone_host, onedata_access_token,
                     ['krakow.onedata.org'])

Building and running tests

virtualenv -p /usr/bin/python3 venv
. venv/bin/activate

# Install tox
pip install coverage tox

# Run flake8 check
tox -c tox.ini -e flake8

# Run yapf check
tox -c tox.ini -e yapf

# Run mypy typing check
tox -c tox.ini -e mypy

# Run PyFilesystem test suite
tox -c tox.ini -e fstest

Running tests automatically

make submodules

virtualenv -p /usr/bin/python3 venv
. venv/bin/activate

./ct_run.py --verbose --image onedata/pybuilder:v2 --onenv-config tests/test_env_config.yaml --no-clean -s --suite flake8 --suite yapf --suite mypy --suite tests

Documentation

• PyFilesystem Wiki
• OnedataRESTFS Reference
• Onedata Homepage