Quickstart

Install

uv add oridecon-storage

Add optional extras for cloud backends:

uv add "oridecon-storage[aws]"    # aiobotocore for S3, R2
uv add "oridecon-storage[gcp]"    # gcloud-aio-storage for GCS
uv add "oridecon-storage[azure]"  # azure-storage-blob for Azure

The local and memory drivers require no extra dependencies.

Minimal Example

import asyncio
from oridecon import Application
from oridecon.contracts import BlobStoreProtocol
from oridecon.storage import StorageModule, StorageConfig


async def main() -> None:
    async with Application.boot(
        name="storage-demo",
        modules=[
            StorageModule.configure(
                StorageConfig(default_driver="memory")
            ),
        ],
    ) as app:
        store = await app.container.resolve(BlobStoreProtocol)
        info = await store.upload("hello.txt", b"Hello, world!")
        print(f"Uploaded: {info.path} ({info.size} bytes)")
        data = await store.download("hello.txt")
        print(f"Downloaded: {data.decode()}")


asyncio.run(main())

For local filesystem:

config = StorageConfig(
    default_driver="local",
    drivers={"local": {"root_dir": "./storage"}},
)

What Just Happened

StorageModule.configure() creates a StorageProvider with the given config.
The provider registers a BlobStoreProtocol singleton in the container.
On boot, it verifies connectivity (health check).
Your service receives the store via constructor injection.

Next Steps

Guide — mental model, core concepts, common patterns
How-Tos — task-oriented recipes
Configuration — every config key with env-var names