storage-kernel-provider-local-filesystem

Local filesystem provider for Storage Kernel.

This provider is useful for local development, tests, CI without cloud infrastructure, and projects that intentionally store files on disk.

Install

uv add storage-kernel-contracts storage-kernel-provider-local-filesystem

Usage

from storage_kernel.contracts import StorageClientOptions, StorageLocation, StoragePath
from storage_kernel.provider_local_filesystem import create_local_filesystem_storage_client

storage = create_local_filesystem_storage_client(
    StorageClientOptions(location=StorageLocation(directory=".storage"))
)

await storage.send_content(StoragePath("docs/readme.txt"), "Hello")

StorageLocation.directory is mandatory and non-empty. Paths are resolved safely inside it, and empty logical paths are rejected.

Provider Options

Capabilities

• full binary and text reads/writes
• read streams and writable upload streams
• recursive directory reads and deletes
• same-provider native copy
• safe path resolution inside StorageLocation.directory
• public URLs when public_base_url is configured

Signed URLs are not supported by the local filesystem provider and raise a normalized capability error.