rick-vfs 2.0.0

Minio/S3 client VFS abstraction library

rick-vfs

Minio/S3 client VFS abstraction library

Rick-vfs is a high-level abstraction library for file operations on local repositories (a locally accessible folder) and Minio/S3 object storage systems. The main goal is to provide a set of common interface functions with analogous behaviour, to interact with both scenarios.

The intention of "analogous behaviour" is to mimick overall intent and response type, when possible. There will always be differences between invoking a given method on two different backends.

Example:

from io import BytesIO
from minio import Minio
from rick_vfs.s3 import MinioBucket, MinioVfs

client = Minio(
    "localhost:9010",
    secure=False,
    access_key="SomeTestUser",
    secret_key="SomeTestPassword",
)

# initialize bucket
volume = MinioBucket(client, 'my-bucket')
# initialize VFS object
vfs = MinioVfs(volume)

# create directory
vfs.mkdir("contents/files")

# create file from buffer
buf = BytesIO(b'the quick brown fox jumps over the lazy dog')
vfs.write_file(buf, 'contents/files/my_test_file')

# read file
contents = vfs.read_file('my_test_file')
# print contents
print(str(contents.getbuffer().tobytes(), 'utf-8'))

# list bucket contents
print("Bucket contents:")
for item in vfs.ls():
    print(item.object_name)

Object lock

The S3 backend supports the full set of S3 object-lock primitives — bucket lock configuration, versioning, per-object retention (GOVERNANCE / COMPLIANCE), legal hold, governance-bypass deletion and version-targeted operations. Lock support is exposed through the VfsObjectLock and VfsLockableVolume capability interfaces, so a backend can be probed with isinstance():

from rick_vfs import VfsObjectLock

if isinstance(vfs, VfsObjectLock):
    vfs.enable_legal_hold("my-object")

See Object lock & versioning for details.