simple-module-file-storage 0.0.20

Pluggable file upload + storage (local or S3 via extras) module for simple_module apps

simple_module_file_storage

Pluggable file-upload + storage module for simple_module apps. Defaults to local-disk storage for development; install the [s3] extra to switch to any S3-compatible backend via aioboto3.

Install

# local-disk storage (dev default)
pip install simple_module_file_storage

# S3-compatible storage (production)
pip install "simple_module_file_storage[s3]"

What it provides

• POST /api/file-storage/upload multipart upload endpoint.
• GET /api/file-storage/files (paged list), GET /api/file-storage/files/{file_id} (metadata), GET /api/file-storage/files/{file_id}/download (signed-URL redirect or stream), DELETE /api/file-storage/files/{file_id}.
• Pluggable backend selected by the backend setting (filesystem default | s3); third-party backends can register under any id.
• Settings (backend, s3_bucket, s3_region, s3_endpoint_url for R2/MinIO/etc., s3_access_key_id, s3_secret_access_key, s3_presign_ttl_seconds) are configured from the DB settings store via the admin UI — they are not read from SM_FILE_STORAGE_* environment variables at runtime.

Usage

From another module, inject the service via its dependency:

from fastapi import Depends, File, UploadFile

from file_storage.deps import get_file_storage_service   # type: ignore[import-not-found]
from file_storage.service import FileStorageService      # type: ignore[import-not-found]

async def attach_receipt(
    upload: UploadFile = File(...),
    svc: FileStorageService = Depends(get_file_storage_service),
):
    record = await svc.upload(upload)
    return {"file_id": record.id}

Backend and S3 credentials are configured from the admin UI at /settings/modules → FileStorage (DB-backed settings); switch backend to s3 and fill in s3_bucket, s3_region, s3_endpoint_url (for MinIO/R2), s3_access_key_id, and s3_secret_access_key.

Depends on

• simple_module_core, simple_module_db, simple_module_hosting, simple_module_settings
• aiofiles
• Optional: aioboto3 (install the [s3] extra)

License

MIT — see LICENSE.