Skip to main content

Wrapper of boto package for django

Project description

# Django-boto

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/qnub/django-boto?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Is an implementation of Django integration with [Amazon AWS](http://aws.amazon.com/) services through [boto](https://github.com/boto/boto) module.

# Installation

To install:

easy_install django-boto

or:

pip install django-boto

# Configuration

## DEFAULT_FILE_STORAGE

Can’t be used as default file storage system because of path not implemented but you still can pass S3Storage object as storage option to a FileField:

from django.db import models from django_boto.s3.storage import S3Storage

s3 = S3Storage()

class Car(models.Model):
… photo = models.ImageField(storage=s3)

## Other settings.py options

AWS_ACCESS_KEY_ID
(required for default file storage use) Access Key ID from Security Credentials settings on AWS service. Required for using as default storage.
AWS_SECRET_ACCESS_KEY
(required for default file storage use) Secret Access Key from Security Credentials settings on AWS service. Required for using as default storage.
AWS_ACL_POLICY
Default canned ACL for objects saved. Defaults to public-read.
BOTO_S3_BUCKET
Amazon S3 bucket name. Default set to AWS_ACCESS_KEY_ID.
BOTO_S3_HOST
Amazon S3 hostname. Default to s3.amazonaws.com.
BOTO_BUCKET_LOCATION
Amazon datacenter location. Default to US Classic Region.
AWS_S3_FORCE_HTTP_URL
Default to False. This settings allow you forcing S3 to return http links to files (if you have problem with SSL).

# Usage

## Manual S3Storage usage

If you need to use it manually - you can pass bucket_name (as BOTO_S3_BUCKET), key (as AWS_ACCESS_KEY_ID), secret (as AWS_SECRET_ACCESS_KEY) and location (as BOTO_BUCKET_LOCATION) directly to storage constructor:

from django_boto.s3.storage import S3Storage

s3 = S3Storage(bucket_name=’another-bucket’, key=’another-key’,
secret=’another-secret’, location=’EU’)

S3Storage is a typical [Django storage system](http://readthedocs.org/docs/django/en/1.4/ref/files/storage.html#the-storage-class), only path is not implemented and created_time and accessed_time return same value as modified_time.

## Upload shortcut

You can use a shortcut for simple uploads:

from django_boto.s3 import upload

upload(filename, name=None, prefix=False, bucket_name=False, key=None,
secret=None, host=None, expires=0, query_auth=False, force_http=True, policy=None)

where:

filename:
string filesystem path to file or django File instance or python file object instance;
name:
string target Django’s name for uploading the file;
prefix:
string path prefix to filename in s3.amazonaws.com url. Like filename /images/image.jpg with avatars prefix convert to avatars/image.jpg in amazon url;
bucket_name:
name of bucket (if not exists - system try to create it) in amazon S3;
key:
AWS_ACCESS_KEY_ID replacement;
secret:
AWS_SECRET_ACCESS_KEY replacement.
host:
BOTO_S3_HOST replacement.
expires:
int How long should private links be valid for.
query_auth:
bool Should the url be generated with a valid signature? Required for private files.
force_http:
bool Should the generated url be http?
policy:
string Canned acl string for uploaded objects.

Last nine options are optional. If not set - it’s taken from the settings.py or defaults are used.

upload() returns a generated URL for a file download.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-boto, version 0.3.12
Filename, size File type Python version Upload date Hashes
Filename, size django-boto-0.3.12.tar.gz (7.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page