===============

django-storages

.. image:: https://img.shields.io/pypi/v/django-storages.svg :target: https://pypi.python.org/pypi/django-storages :alt: PyPI Version

.. image:: https://travis-ci.org/jschneier/django-storages.svg?branch=master :target: https://travis-ci.org/jschneier/django-storages :alt: Build Status

Installation

Installing from PyPI is as easy as doing::

pip install django-storages

If you'd prefer to install from source (maybe there is a bugfix in master that hasn't been released yet) then the magic incantation you are looking for is::

pip install -e 'git+https://github.com/jschneier/django-storages.git#egg=django-storages'

Once that is done add storages to your INSTALLED_APPS and set DEFAULT_FILE_STORAGE to the backend of your choice. If, for example, you want to use the boto3 backend you would set::

DEFAULT_FILE_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'

There are also a number of settings available to control how each storage backend functions, please consult the documentation for a comprehensive list.

About

django-storages is a project to provide a variety of storage backends in a single library.

This library is usually compatible with the currently supported versions of Django. Check the trove classifiers in setup.py to be sure.

History

This repo began as a fork of the original library under the package name of django-storages-redux and became the official successor (releasing under django-storages on PyPI) in February of 2016.

Found a Bug? Something Unsupported?

I suspect that a few of the storage engines in backends/ have been unsupported for quite a long time. I personally only really need the S3Storage backend but welcome bug reports (and especially) patches and tests for some of the other backends.

Issues are tracked via GitHub issues at the project issue page <https://github.com/jschneier/django-storages/issues>_.

Documentation

The original documentation for django-storages is located at https://django-storages.readthedocs.org/. Stay tuned for forthcoming documentation updates.

Contributing

#. Check for open issues <https://github.com/jschneier/django-storages/issues> at the project issue page or open a new issue to start a discussion about a feature or bug. #. Fork the django-storages repository on GitHub <https://github.com/jschneier/django-storages> to start making changes. #. Add a test case to show that the bug is fixed or the feature is implemented correctly. #. Bug me until I can merge your pull request. Also, don't forget to add yourself to AUTHORS.

django-storages change log

1.6.0 (XXXX-XX-XX)

Breaking: Remove backends deprecated in v1.5.1 (#280_)
Deprecation: The undocumented gs.GSBotoStorage backend. See the new gcloud.GoogleCloudStorage or apache_libcloud.LibCloudStorage backends instead. (#236_)
Add a new backend, gcloud.GoogleCloudStorage based on the google-cloud bindings. (#236_ thanks @scjody)
Pass in the location constraint when auto creating a bucket (#257, #258 thanks @mattayes)
Add support for reading AWS_SESSION_TOKEN and AWS_SECURITY_TOKEN from the environment to S3Boto3Storage and S3BotoStorage. (#283_ thanks @bxm156)
Fix Boto3 non-ascii filenames on Python 2.7 (#216, #217 thanks @AGASS007)
Fix collectstatic timezone handling in and add get_modified_time to S3BotoStorage (#290_)
Add support for Django 1.11 (#295_ thanks @jdufresne)
Add project keyword support to GCS in LibCloudStorage backend (#269_ thanks @slightfoot)
Files that have a guessable encoding (e.g. gzip or compress) will be uploaded with that Content-Encoding in the s3boto3 backend (issue #263 pr #264 thanks @ldng)
The Dropbox backend now properly translates backslashes in Windows paths into forward slashes (e52a127_)

1.5.2 (2017-01-13)

Actually use SFTP_STORAGE_HOST in SFTPStorage backend (#204_ thanks @jbittel)
Fix S3Boto3Storage to avoid race conditions in a multi-threaded WSGI environment (#238_ thanks @jdufresne)
Fix trying to localize a naive datetime when settings.USE_TZ is False in S3Boto3Storage.modified_time. (thanks to @tomchuk and @piglei for the reports and the patches, #235, #234)
Fix automatic bucket creation in S3Boto3Storage when AWS_AUTO_CREATE_BUCKET is True (#196_ thanks @linuxlewis)
Improve the documentation for the S3 backends (thanks to various contributors!)

.. #204: https://github.com/jschneier/django-storages/pull/204 .. #238: https://github.com/jschneier/django-storages/pull/238 .. #234: https://github.com/jschneier/django-storages/issues/234 .. #235: https://github.com/jschneier/django-storages/pull/235 .. _#196: https://github.com/jschneier/django-storages/pull/196

1.5.1 (2016-09-13)

Breaking: Drop support for Django 1.7 (#185_)
Deprecation: hashpath, image, overwrite, mogile, symlinkorcopy, database, mogile, couchdb. See (issue #202_) to discuss maintenance going forward
Use a fixed mtime argument for GzipFile in S3BotoStorage and S3Boto3Storage to ensure a stable output for gzipped files
Use .putfileobj instead of .put in S3Boto3Storage to use the transfer manager, allowing files greater than 5GB to be put on S3 (#194 , #201)
Update S3Boto3Storage for Django 1.10 (#181_) (get_modified_time and get_accessed_time) thanks @JshWright
Fix bad kwarg name in S3Boto3Storage when AWS_PRELOAD_METADATA is True (#189, #190) thanks @leonsmith

.. issue #202: https://github.com/jschneier/django-storages/issues/202 .. #201: https://github.com/jschneier/django-storages/pull/201 .. #194: https://github.com/jschneier/django-storages/issues/194 .. #190: https://github.com/jschneier/django-storages/pull/190 .. #189: https://github.com/jschneier/django-storages/issues/189 .. #185: https://github.com/jschneier/django-storages/pull/185 .. _#181: https://github.com/jschneier/django-storages/pull/181

1.5.0 (2016-08-02)

Add new backend S3Boto3Storage (#179_) MASSIVE THANKS @mbarrien
Add a strict option to utils.setting (#176_) thanks @ZuluPro
Tests, documentation, fixing .close for SFTPStorage (#177_) thanks @ZuluPro
Tests, documentation, add .readlines for FTPStorage (#175_) thanks @ZuluPro
Tests and documentation for DropBoxStorage (#174_) thanks @ZuluPro
Fix MANIFEST.in to not ship .pyc files. (#145_) thanks @fladi
Enable CI testing of Python 3.5 and fix test failure from api change (#171_) thanks @tnir

.. #145: https://github.com/jschneier/django-storages/pull/145 .. #171: https://github.com/jschneier/django-storages/pull/171 .. #174: https://github.com/jschneier/django-storages/pull/174 .. #175: https://github.com/jschneier/django-storages/pull/175 .. #177: https://github.com/jschneier/django-storages/pull/177 .. #176: https://github.com/jschneier/django-storages/pull/176 .. _#179: https://github.com/jschneier/django-storages/pull/179

1.4.1 (2016-04-07)

Files that have a guessable encoding (e.g. gzip or compress) will be uploaded with that Content-Encoding in the s3boto backend. Compressable types such as application/javascript will still be gzipped. PR #122_ thanks @cambonf
Fix DropBoxStorage.exists check and add DropBoxStorage.url (#127_) thanks @zuck
Add GS_HOST setting (with a default of GSConnection.DefaultHost) to fix GSBotoStorage. Issue #124. Fixed in #125. Thanks @patgmiller @dcgoss.

.. #122: https://github.com/jschneier/django-storages/pull/122 .. #127: https://github.com/jschneier/django-storages/pull/127 .. #124: https://github.com/jschneier/django-storages/issues/124 .. #125: https://github.com/jschneier/django-storages/pull/125

1.4 (2016-02-07)

This package is now released on PyPI as django-storages. Please update your requirements files to django-storages==1.4.

1.3.2 (2016-01-26)

Fix memory leak from not closing underlying temp file in s3boto backend (#106_) thanks @kmmbvnr
Allow easily specifying a custom expiry time when generating a url for S3BotoStorage (#96_) thanks @mattbriancon
Check for bucket existence when the empty path ('') is passed to storage.exists in S3BotoStorage - this prevents a crash when running collectstatic -c on Django 1.9.1 (#112) fixed in #116 thanks @xblitz

.. #106: https://github.com/jschneier/django-storages/pull/106 .. #96: https://github.com/jschneier/django-storages/pull/96 .. #112: https://github.com/jschneier/django-storages/issues/112 .. #116: https://github.com/jschneier/django-storages/pull/116

1.3.1 (2016-01-12)

A few Azure Storage fixes [pass the content-type to Azure, handle chunked content, fix url] (#45__) thanks @erlingbo
Add support for a Dropbox (dropbox) storage backend, thanks @ZuluPro (#76_)
Various fixes to the apache_libcloud backend [return the number of bytes asked for by .read, make .name non-private, don't initialize to an empty BytesIO object] thanks @kaedroho (#55_)
Fix multi-part uploads in s3boto backend not respecting AWS_S3_ENCRYPTION (#94_) thanks @andersontep
Automatically gzip svg files thanks @comandrei (#100_)

.. _: https://github.com/jschneier/django-storages/pull/45 .. #76: https://github.com/jschneier/django-storages/pull/76 .. #55: https://github.com/jschneier/django-storages/pull/55 .. #94: https://github.com/jschneier/django-storages/pull/94 .. _#100: https://github.com/jschneier/django-storages/pull/100

1.3 (2015-08-14)

Breaking: Drop Support for Django 1.5 and Python 2.6
Breaking: Remove previously deprecated mongodb backend
Breaking: Remove previously deprecated parse_ts_extended from s3boto storage
Add support for Django 1.8+ (#36__)
Add AWS_S3_PROXY_HOST and AWS_S3_PROXY_PORT settings for s3boto backend (#41_)
Fix Python3K compat issue in apachelibcloud (#52)
Fix Google Storage backend not respecting GS_IS_GZIPPED setting (#51_, #60) thanks @stmos
Rename FTP _name attribute to name which is what the Django File api is expecting (#70_)
Put StorageMixin first in inheritance to maintain backwards compat with older versions of Django (#63_)

.. : https://github.com/jschneier/django-storages/pull/36 .. #41: https://github.com/jschneier/django-storages/pull/41 .. #52: https://github.com/jschneier/django-storages/issues/52 .. : https://github.com/jschneier/django-storages/pull/51 .. #60: https://github.com/jschneier/django-storages/pull/60 .. #70: https://github.com/jschneier/django-storages/pull/70 .. _#63: https://github.com/jschneier/django-storages/pull/63

1.2.3 (2015-03-14)

Variety of FTP backend fixes (fix exists, add modified_time, remove call to non-existent function) (#26_)
Apparently the year changed to 2015

.. _#26: https://github.com/jschneier/django-storages/pull/26

1.2.2 (2015-01-28)

Remove always show all warnings filter (#21_)
Release package as a wheel
Avoid resource warning during install (#20__)
Made S3BotoStorage deconstructible (previously only S3BotoStorageFile was deconstructible) (#19_)

.. #21: https://github.com/jschneier/django-storages/pull/21 .. __: https://github.com/jschneier/django-storages/issues/20 .. #19: https://github.com/jschneier/django-storages/pull/19

1.2.1 (2014-12-31)

Deprecation: Issue warning about parse_ts_extended
Deprecation: mongodb backend - django-mongodb-engine now ships its own storage backend
Fix storage.modified_time crashing on new files when AWS_PRELOAD_METADATA=True (#11, #12__, #14)

.. #11: https://github.com/jschneier/django-storages/pull/11 __ https://github.com/jschneier/django-storages/issues/12 .. #14: https://github.com/jschneier/django-storages/pull/14

1.2 (2014-12-14)

Breaking: Remove legacy S3 storage (#1_)
Breaking: Remove mosso files backend (#2_)
Add text/javascript mimetype to S3BotoStorage gzip allowed defaults
Add support for Django 1.7 migrations in S3BotoStorage and ApacheLibCloudStorage (#5, #8)
Python3K (3.3+) now available for S3Boto backend (#4_)

.. #8: https://github.com/jschneier/django-storages/pull/8 .. #5: https://github.com/jschneier/django-storages/pull/5 .. #4: https://github.com/jschneier/django-storages/pull/4 .. #1: https://github.com/jschneier/django-storages/issues/1 .. _#2: https://github.com/jschneier/django-storages/issues/2

NOTE: Version 1.1.9 is the first release of django-storages after the fork. It represents the current (2014-12-08) state of the original django-storages in master with no additional changes. This is the first release of the code base since March 2013.

1.1.9 (2014-12-08)

Fix syntax for Python3 with pull-request #91_
Support pushing content type from File object to GridFS with pull-request #90_
Support passing a region to the libcloud driver with pull-request #86_
Handle trailing slash paths fixes #188 fixed by pull-request #85
Use a SpooledTemporaryFile to conserve memory in S3BotoFile pull-request #69_
Guess content-type for S3BotoStorageFile the same way that _save() in S3BotoStorage does
Pass headers and responseheaders through from url to generate_url in S3BotoStorage pull-request #65
Added AWSS3_HOST, AWS_S3_PORT and AWS_S3_USE_SSL settings to specify host, port and is_secure in pull-request #66

Everything Below Here Was Previously Released on PyPi under django-storages

1.1.8 (2013-03-31)

Fixes #156_ regarding date parsing, ValueError when running collectstatic
Proper handling of boto dev version parsing
Made SFTP URLs accessible, now uses settings.MEDIA_URL instead of sftp://

.. _#156: https://bitbucket.org/david/django-storages/issue/156/s3boto-backend-valueerror-time-data-thu-07

1.1.7 (2013-03-20)

Listing of huge buckets on S3 is now prevented by using the prefix argument to boto's list() method
Initial support for Windows Azure Storage
Switched to useing boto's parse_ts date parser getting last modified info when using S3boto backend
Fixed key handling in S3boto and Google Storage backends
Account for lack of multipart upload in Google Storage backend
Fixed seek() issue when using AWSIS_GZIPPED by darkness51 with pull-request #50
Improvements to S3BotoStorage and GSBotoStorage

.. _#50: https://bitbucket.org/david/django-storages/pull-request/50/

1.1.6 (2013-01-06)

Merged many changes from Jannis Leidel (mostly regarding gzipping)
Fixed tests by Ian Lewis
Added support for Google Cloud Storage backend by Jannis Leidel
Updated license file by Dan Loewenherz, fixes #133 with pull-request #44
Set Content-Type header for use in upload_part_from_file by Gerardo Curiel
Pass the rewind parameter to Boto's setcontents_from_file method by Jannis Leidel with pull-request #45
Fix for FTPStorageFile close() method by Mathieu Comandon with pull-request #43_
Minor refactoring by Oktay Sancak with pull-request #48_
Ungzip on download based on Content-Encoding by Gavin Wahl with pull-request #46_
Add support for S3 server-side encryption by Tobias McNulty with pull-request #17_
Add an optional setting to the boto storage to produce protocol-relative URLs, fixes #105_

1.1.5 (2012-07-18)

Merged pull request #36_ from freakboy3742 Keith-Magee, improvements to Apache Libcloud backend and docs
Merged pull request #35_ from atodorov, allows more granular S3 access settings
Add support for SSL in Rackspace Cloudfiles backend
Fixed the listdir() method in s3boto backend, fixes #57_
Added base url tests for safe_join in s3boto backend
Merged pull request #20_ from alanjds, fixed SuspiciousOperation warning if AWS_LOCATION ends with '/'
Added FILE_BUFFER_SIZE setting to s3boto backend
Merged pull request #30 from pendletongp, resolves #108, #109 and #110
Updated the modifiedtime() method so that it doesn't require dateutil. fixes #111
Merged pull request #16_ from chamal, adds Apache Libcloud backend
When preloading the S3 metadata make sure we reset the files key during saving to prevent stale metadata
Merged pull request #24_ from tobias.mcnulty, fixes bug where s3boto backend returns modified_time in wrong time zone
Fixed HashPathStorage.location to no longer use settings.MEDIA_ROOT
Remove download_url from setup file so PyPI dist is used

1.1.4 (2012-01-06)

Added PendingDeprecationWarning for mosso backend
Merged pull request #13_ from marcoala, adds SFTP_KNOWN_HOST_FILE setting to SFTP storage backend
Merged pull request #12_ from ryankask, fixes HashPathStorage tests that delete remote media
Merged pull request #10_ from key, adds support for django-mongodb-engine 0.4.0 or later, fixes GridFS file deletion bug
Fixed S3BotoStorage performance problem calling modified_time()
Added deprecation warning for s3 backend, refs #40_
Fixed CLOUDFILESCONNECTION_KWARGS import error, fixes #78
Switched to sphinx documentation, set official docs up on http://django-storages.rtfd.org/
HashPathStorage uses self.exists now, fixes #83_

.. #13: https://bitbucket.org/david/django-storages/pull-request/13/a-version-of-sftp-storage-that-allows-you .. #12: https://bitbucket.org/david/django-storages/pull-request/12/hashpathstorage-tests-deleted-my-projects .. #10: https://bitbucket.org/david/django-storages/pull-request/10/support-django-mongodb-engine-040 .. #40: https://bitbucket.org/david/django-storages/issue/40/deprecate-s3py-backend .. #78: https://bitbucket.org/david/django-storages/issue/78/import-error .. #83: https://bitbucket.org/david/django-storages/issue/6/symlinkorcopystorage-new-custom-storage

1.1.3 (2011-08-15)

Created this lovely change log
Fixed #89_: broken StringIO import in CloudFiles backend
Merged pull request #5_: HashPathStorage path bug

.. _#89: https://bitbucket.org/david/django-storages/issue/89/112-broke-the-mosso-backend .. _pull request #5: https://bitbucket.org/david/django-storages/pull-request/5/fixed-path-bug-and-added-testcase-for

django-storages-afix

https://django-storages.readthedocs.io/

by Josh Schneier

django-storages

Installation

About

History

Found a Bug? Something Unsupported?

Documentation

Contributing

django-storages change log

User Ratings

Top Feedback

Popularity

GitHub Stars

Maintenance

LAST COMMIT

MAINTAINERS

CONTRIBUTORS

OPEN ISSUES

OPEN PRs

Versions

Alternatives

Tutorials