SQLAlchemy-ImageAttach

SQLAlchemy-ImageAttach is a SQLAlchemy extension for attaching images to entity objects. It provides the following features:

Storage backend interface

You can use file system backend on your local development box, and switch it to AWS S3 when it’s deployed to the production box. Or you can add a new backend implementation by yourself.

Maintaining multiple image sizes

Any size of thumbnails can be generated from the original size without assuming the fixed set of sizes. You can generate a thumbnail of a particular size if it doesn’t exist yet when the size is requested. Use RRS (Reduced Redundancy Storage) for reproducible thumbnails on S3.

Every image has its URL

Attached images can be exposed as a URL.

SQLAlchemy transaction aware

Saved file are removed when the ongoing transaction has been rolled back.

Tested on various environments

• Python versions: Python 2.7, 3.3 or higher, PyPy
• DBMS: PostgreSQL, MySQL, SQLite
• SQLAlchemy: 0.9 or higher (tested on 0.9 to 1.1; see CI as well)

Installation

It’s available on PyPI:

$ pip install SQLAlchemy-ImageAttach

User’s guide

• Declaring Image Entities
  • Object type
  • Object identifier
• Storages
  • Choosing the right storage implementation
  • Using filesystem on the local development box
  • Implementing your own storage
  • Migrating storage
• Attaching Images
  • Context
  • Attaching from file object
  • Attaching from byte string
  • Getting image urls
  • Getting image files
  • Getting image binary
  • Thumbnails
  • Expliciting storage
  • Implicit contexts
• Multiple Image Sets
  • Object identifier
  • Choosing image set to deal with
• SQLAlchemy-ImageAttach Changelog
  • Version 1.1.0
  • Version 1.0.0
  • Version 0.9.0
  • Version 0.8.2
  • Version 0.8.1
  • Version 0.8.0
  • Version 0.8.0.dev-20130531

sqlalchemy_imageattach — API

• sqlalchemy_imageattach.context — Scoped context of image storage
• sqlalchemy_imageattach.entity — Image entities
• sqlalchemy_imageattach.file — File proxies
• sqlalchemy_imageattach.migration — Storage migration
• sqlalchemy_imageattach.store — Image storage backend interface
• sqlalchemy_imageattach.util — Utilities
• sqlalchemy_imageattach.version — Version data

sqlalchemy_imageattach.stores — Storage backend implementations

• sqlalchemy_imageattach.stores.fs — Filesystem-backed image storage
• sqlalchemy_imageattach.stores.s3 — AWS S3 backend storage

Open source

SQLAlchemy-ImageAttach is an open source software written by Hong Minhee. The source code is distributed under MIT license, and you can find it at GitHub repository:

$ git clone git://github.com/dahlia/sqlalchemy-imageattach.git

If you find any bug, please create an issue to the issue tracker. Pull requests are also always welcome!

Check out Changelog as well.