Skip to main content

Django view for AWS S3 signing

Project description

[![Build Status](](
[![Coverage Status](](

# django-s3sign
s3 sign view for django

## installation

$ pip install django-s3sign

## usage

Add `s3sign` to `INSTALLED_APPS`. Subclass `s3sign.views.SignS3View`
and override as needed.

Attributes you can override (and their default values):

name_field = 's3_object_name'
type_field = 's3_object_type'
expiration_time = 10
mime_type_extensions = [
('jpeg', '.jpg'),
('png', '.png'),
('gif', '.gif'),
default_extension = '.obj'
root = ''
path_string = (
amz_headers = "x-amz-acl:public-read"

Methods you can override:

* `get_aws_access_key(self)`
* `get_aws_secret_key(self)`
* `get_bucket(self)`
* `get_mimetype(self, request)`
* `extension_from_mimetype(self, mime_type)`
* `now(self)` # useful for unit tests
* `now_time(self)` # useful for unit tests
* `basename(self)`
* `get_object_name(self, extension)`

Most of those should be clear. Read the source if in doubt.

Eg to use a different root path:

from s3sign.views import SignS3View

class MySignS3View(LoggedInView, SignS3View):
root = 'uploads/'

With a different S3 bucket:

class MySignS3View(LoggedInView, SignS3View):
def get_bucket(self):

Keeping the uploaded filename instead of doing a random one and
whitelisted extension:

class MySignS3View(LoggedInView, SignS3View):
def basename(self, request):
filename = request.GET[self.get_name_field()]
return os.path.basename(filename)

def extension(self, request):
filename = request.GET[self.get_name_field()]
return os.path.splitext(filename)[1]

### javascript/forms

The required javascript is also included, so you can include it in
your page with:

<script src="{{STATIC_URL}}s3sign/js/s3upload.js"></script>

Your form would then somewhere have a bit like:

<p id="status"><b>Please select a file</b></p>
<input type="file" id="file" onchange="s3_upload();"/>
<input type="hidden" name="s3_url" id="uploaded-url" />


function s3_upload() {
var s3upload = new S3Upload({
file_dom_selector: 'file',
s3_sign_put_url: '/sign_s3/', // change this if you route differently
s3_object_name: $('#file')[0].value,

onProgress: function(percent, message) {
$('#status').html('Upload progress: ' + percent + '%' + message);
onFinishS3Put: function(url) {
onError: function(status) {
$('#status').html('Upload error: ' + status);

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-s3sign, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size django_s3sign-0.1.4-py2.py3-none-any.whl (8.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-s3sign-0.1.4.tar.gz (5.5 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