DEPOT is a framework for easily storing and serving files in web applications on Python2.6+ and Python3.2+.
DEPOT supports storing files in multiple backends, like:
- Local Disk
- In Memory (for tests)
- On GridFS
- On Amazon S3 (or compatible services)
- On Google Cloud Storage
and integrates with database by providing files attached to your SQLAlchemy or Ming/MongoDB models with respect to transactions behaviours (files are rolled back too).
Installing DEPOT can be done from PyPi itself by installing the filedepot
distribution:
$ pip install filedepot
To start using Depot refer to Documentation
DEPOT was presented at PyConUK and PyConFR in 2014
Here is a simple example of using depot standalone to store files on MongoDB:
from depot.manager import DepotManager # Configure a *default* depot to store files on MongoDB GridFS DepotManager.configure('default', { 'depot.backend': 'depot.io.gridfs.GridFSStorage', 'depot.mongouri': 'mongodb://localhost/db' }) depot = DepotManager.get() # Save the file and get the fileid fileid = depot.create(open('/tmp/file.png')) # Get the file back stored_file = depot.get(fileid) print stored_file.filename print stored_file.content_type
Or you can use depot with SQLAlchemy to store attachments:
from depot.fields.sqlalchemy import UploadedFileField from depot.fields.specialized.image import UploadedImageWithThumb class Document(Base): __tablename__ = 'document' uid = Column(Integer, autoincrement=True, primary_key=True) name = Column(Unicode(16), unique=True) content = Column('content_col', UploadedFileField) # plain attached file # photo field will automatically generate thumbnail photo = Column(UploadedFileField(upload_type=UploadedImageWithThumb)) # Store documents with attached files, the source can be a file or bytes doc = Document(name=u'Foo', content=b'TEXT CONTENT STORED AS FILE', photo=open('/tmp/file.png')) DBSession.add(doc) DBSession.flush() # DEPOT is session aware, commit/rollback to keep or delete the stored files. DBSession.commit()
- Officially support Python 3.12
- Addressed deprecation of
Image.ANTIALIAS
in Pillow,Image.LANCZOS
is used instead - TurboGears2 is no longer needed to run tests
- Depot is now compatible with
multipart
module or other replacements ofcgi.FieldStorage
- Fixed an open file leak in
UploadedImageWithThumb
- Fixed an open file leak in
WithThumbnailFilter
- Added support for Google Cloud Storage
- Fixed ACL issues with S3
- Deprecated boto2 backend, use boto3
- Added support for performing backups by copying to another storage
- Support for SQLAlchemy 1.4 and 2.0
- Support for SQLAlchemy objects deleted with
.delete(synchronize_session="fetch")
- Tests migrated to
unittest
- Replaced
unidecode
dependency withanyascii
to better cope with MIT License.
- Fix a bug in AWS-S3 support for unicode filenames.
- Support for
storage_class
option indepot.io.boto3.S3Storage
backend. Detaults toSTANDARD
- Officially support Python 3.7
- Fix DEPOT wrongly serving requests for any url that starts with the mountpoint. (IE:
/depotsomething
was wrongly served for/depot
mountpoint) - In SQLAlchemy properly handle deletion of objects deleted through
Relationship.remove
(IE:parent.children.remove(X)
) - In SQLAlchemy properly handle entities deleted through
cascade='delete-orphan'
- Fixed an start_response called a second time without providing exc_info error with storages supporting plublic urls
- URLs generated by
DepotMiddleware
are now guaranteed to be plain ascii - [Breaking change]: Bucket existance with S3 storages should now be more reliable when the bucket didn't already exist, but it requires an additional AWS policy: s3:ListAllMyBuckets that wasn't required on 0.5.0
depot.io.boto3.S3Storage
now provides support for accessing S3 withboto3
. The previously existingdepot.io.awss3.S3Storage
can still be used to store files on S3 usingboto
.- SQLAlchemy integration now handles deletion of files on rollback when session is not flushed. Previously flushing the session was required before a rollback too.
- It is now possible to run tests through
tox
and build docs throughtox -e docs
- DEPOT is now tested against Python 3.6
- Fixed installation error on non-UTF8 systems
- Improved support for polymorphic subtypes in SQLAlchemy
- Support for Python 3.5
- Fixed
Content-Disposition
header for filenames including a comma
MemoryFileStorage
now accepts any option, for easier testing configuration
- Fixed
Content-Disposition
header when serving from S3 directly - Fixed size of SQLAlchemy field on Oracle (was bigger than the allowed maximum)
MemoryFileStorage
provides in memory storage for files. This is meant to provide a convenient way to speed up test suites and avoid fixture clean up issues.- S3Storage can now generate public urls for private files (expire in 1 year)
- Files created from plain bytes are now named "unnamed" instead of missing a filename.
S3Storage
now supports theprefix
option to store files in a subpath
- Storages now provide a
list
method to list files available on the store (This is not meant to be used to retrieve files uploaded by depot as it lists all the files). DepotExtension
for Ming is now properly documented
- It is now possible to use multiple
WithThumbnailFilter
to generate multiple thumbnails with different resolutions. - Better documentation for MongoDB
UploadedFileProperty
- Fixed a bug with Ming support when acessing
UploadedFileProperty
as a class property - Improved support for DEPOT inside TurboGears admin when using MongoDB
- Added
DepotManager.alias
to configure aliases to storage. This allows easy migration from one storage to another by switching where the alias points. - Now
UploadedFileField
permits to specifyupload_storage
to link a Model Column to a specific storage. - Added
policy
andencrypt_key
options to S3Storage to upload private and encrypted files.
- Added host option to S3Storage to allow using providers different from AWS.
- Added FileIntent to explicitly provide content_type and filename to uploaded content.
- Added Content-Disposition header with original filename in WSGI middleware
- Work-Around for issue with wsgi.file_wrapper provided by Waitress WSGI Server
- Official Support for AWS S3 on Python3