nyxa-storage — batteries-included disks for Nyxa

Local filesystem disk by default under {project}/storage/app. Optional S3 via FILESYSTEM_DISK=s3 (nyxa-storage[s3]).

At a glance

Install

uv add nyxa-storage
uv add 'nyxa-storage[s3]'   # boto3

Quick start

from nyxa_storage import Storage

disk = Storage.disk("local")
disk.put("notes/hello.txt", "hi")
disk.copy("notes/hello.txt", "notes/hello-copy.txt")
disk.move("notes/hello-copy.txt", "archive/hello.txt")
assert disk.exists("notes/hello.txt")

Configuration

FILESYSTEM_DISK=local
# STORAGE_ROOT=/absolute/path/to/storage/app

# S3 (or MinIO / R2)
# FILESYSTEM_DISK=s3
# AWS_BUCKET=my-bucket
# AWS_DEFAULT_REGION=us-east-1
# AWS_ACCESS_KEY_ID=...
# AWS_SECRET_ACCESS_KEY=...
# AWS_ENDPOINT_URL=https://...   # optional