django-custom-storage

GitHub

Test

Check Demo Project

Check the demo repo on GitHub

Requirements

Python 3.10+ supported.
Django 4.2+ supported.

Setup

Install from pip:

pip install django-custom-storage

Modify settings.py by adding the app to INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "compressor",
    "custom_storage",
    # ...
]

Configure storage in settings.py. The package ships sensible defaults and reads the project specifics from APP_CONFIG["custom_storage"]; call apply_storage_defaults at the end of the file so the STORAGES, compression and AWS settings are derived for you:

# Project paths (kept in the project; not owned by the package)
MEDIA_ROOT = "/var/opt/your_project_name/mediaroot/"
STATIC_ROOT = "/var/cache/your_project_name/staticroot/"

# AWS credentials
AWS_ACCESS_KEY_ID = "YOUR_PROJECT_AWS_ACCESS_KEY_ID"
AWS_SECRET_ACCESS_KEY = "YOUR_PROJECT_AWS_SECRET_ACCESS_KEY"

# Project-specific options; everything else falls back to the package defaults.
APP_CONFIG = {
    "custom_storage": {
        "BUCKET_NAME": "your_project_bucket_name",
        "CUSTOM_DOMAIN": "cdn.your_project_bucket_name.com",
        # Optional overrides: FILE_EXPIRE, DEFAULT_ACL, PRIVATE_LOCATION, ...
    },
}

from custom_storage.conf import apply_storage_defaults

apply_storage_defaults(globals())

Top-level Django settings always win, so projects that already declare STORAGES, COMPRESS_* or AWS_* keep working unchanged. To serve assets from the local filesystem (handy in development) start the server with --force-local-storage or set FORCE_LOCAL_STORAGE = True.

See Settings for every available key and Storage classes for the backends, including the private storage that serves non-public uploads through signed, expiring URLs.

Run Example Project

git clone --depth=50 --branch=django-custom-storage https://github.com/DLRSP/example.git DLRSP/example
cd DLRSP/example
python manage.py runserver

Now browser the app @ http://127.0.0.1:8000

Release files for django-custom-storage 0.3.20

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

Source distribution (sdist)

Source distribution for django-custom-storage 0.3.20
File	Size	Uploaded
django_custom_storage-0.3.20.tar.gz	42.0 kB	Sep 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for django-custom-storage 0.3.20
File	Interpreter	ABI	Platform	Reset
django_custom_storage-0.3.20-py3-none-any.whl 73.1 kB Sep 1, 2026	Python 3	none	any	Details

Total release size: 115.1 kB

Release files / django_custom_storage-0.3.20.tar.gz

Download URL	django_custom_storage-0.3.20.tar.gz
Size	42.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`89d7f0012fbcac2b42cd1dc9eb8266acbbfb1f3d8d5c666d005cf1323ac12d94`
BLAKE2b-256 checksum How to use checksums	`d73f073f74ff13ebf44ace77edac1c988e3b702e5aa31d4c7bcca6b19f3c0441`
Upload date	Sep 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / django_custom_storage-0.3.20-py3-none-any.whl

Download URL	django_custom_storage-0.3.20-py3-none-any.whl
Size	73.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`eea4bcc53e84f674e3351b46157f16aa657bc90817d837d0131328aa41036a96`
BLAKE2b-256 checksum How to use checksums	`d9a7a18416bf13ccb89336d959719b01d5ffac32bbfbec350cc0df07144d9120`
Upload date	Sep 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`