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]"
Install simple_module_file_storage[tasks] to include the matching
simple_module_background_tasks package, then enable background_tasks and run
its worker for asynchronous multipart-upload checksums. Run its beat scheduler
as well for upload cleanup jobs.
The extras combine as simple_module_file_storage[s3,tasks]. Without
background_tasks, uploads still work; completed multipart uploads keep
checksum_sha256 null. Streamed uploads compute their checksum inline.
What it provides
POST /api/file-storage/uploadmultipart 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
backendsetting (filesystemdefault |s3); third-party backends can register under any id. - Settings (
backend,s3_bucket,s3_region,s3_endpoint_urlfor 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 fromSM_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
from file_storage.service import FileStorageService
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_settingsaiofiles- Optional:
aioboto3(install the[s3]extra) - Optional:
simple_module_background_tasks(install the[tasks]extra)
License
MIT — see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for simple-module-file-storage 0.0.38
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| simple_module_file_storage-0.0.38.tar.gz | 153.0 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simple_module_file_storage-0.0.38-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 280.1 kB
Release files / simple_module_file_storage-0.0.38.tar.gz
| Download URL | simple_module_file_storage-0.0.38.tar.gz |
|---|---|
| Size | 153.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
10b1981bf0481fa829fc5cd302b196fd36cde0bd552aa31298a6b02d15e46c89
|
|
BLAKE2b-256 checksum How to use checksums |
17bf80dd88cb9b9ad57f6b1c1c26a85cb92654f08bf272063836537b8c2df31b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 23, 2026.
Transparency logRelease files / simple_module_file_storage-0.0.38-py3-none-any.whl
| Download URL | simple_module_file_storage-0.0.38-py3-none-any.whl |
|---|---|
| Size | 127.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
101e4eb5815ca8b76a65810b8a71b1478893ad3f94a8497f63774c3482e4d192
|
|
BLAKE2b-256 checksum How to use checksums |
9bc145e299ef17f3026bd38420e78ba05a18a814c14e1838bf1862f072c6d94b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 23, 2026.
Transparency logSecurity for simple-module-file-storage 0.0.38
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.
Attestation for simple_module_file_storage-0.0.38.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 23, 2026.
Transparency logA 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.
