Skip to main content

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.

Metadata

Release files for simple-module-file-storage 0.0.36

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simple-module-file-storage 0.0.36
File Size Uploaded Provenance
simple_module_file_storage-0.0.36.tar.gz 90.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for simple-module-file-storage 0.0.36
File Interpreter ABI Platform
simple_module_file_storage-0.0.36-py3-none-any.whl Python 3 none any Details

Total release size: 167.8 kB

Release files / simple_module_file_storage-0.0.36.tar.gz

Download URL simple_module_file_storage-0.0.36.tar.gz
Size 90.4 kB
Tags Source
SHA-256 checksum
How to use checksums
5d5427c605cab3fb96d2c8e98693755893db7c4f4f8b156848b65a7ae6546280
BLAKE2b-256 checksum
How to use checksums
47188c6ded2a60408df7a54ad16c81c31501c480b983040c373cfff4b66913c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

Release files / simple_module_file_storage-0.0.36-py3-none-any.whl

Download URL simple_module_file_storage-0.0.36-py3-none-any.whl
Size 77.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
605936473e46ecce0ad5dcea31349e8a321c7d6c6fe43ca158a38c776d0ad123
BLAKE2b-256 checksum
How to use checksums
0ac29a370a3c678198060ce9649fd65dc9168970c234c4f156f733a1aefffc58
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

Security for simple-module-file-storage 0.0.36

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for simple_module_file_storage-0.0.36.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.36 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page