This simple django app enables users to upload large files to Django in multiple chunks, with the ability to resume if the upload is interrupted.
This app is intented to work with JQuery-File-Upload by Sebastian Tschan.
-
An initial POST request is sent to the url linked to
ChunkedUploadView
(or any subclass) with the first chunk of the file. The key of this chunk can be overriden in the view (class attributefield_name
). Example:{'my_file': <File>}
-
In return, server with response with the
upload_id
, the currentoffset
and the when will the upload expire (expires
). Example:{'upload_id': '5230ec1f59d1485d9d7974b853802e31', 'offset': 10000, 'expires': '2013-07-18T17:56:22.186Z'}
-
Repeatedly POST subsequent chunks using the
upload_id
to identify the upload to the url linked toChunkedUploadView
(or any subclass). Example:{'upload_id': '5230ec1f59d1485d9d7974b853802e31', 'my_file': <File>}
-
Server will continue responding with the
upload_id
, the currentoffset
and the expiration date (expires
). -
Finally, when upload is completed, a POST request is sent to the url linked to
ChunkedUploadCompleteView
(or any subclass). This request must include theupload_id
and themd5
checksum (hex). Example:{'upload_id': '5230ec1f59d1485d9d7974b853802e31', 'md5': 'fc3ff98e8c6a0d3087d515c0473f8677'}
-
If everything is OK, server will response with status code 200 and the data returned in the method
get_response_data
(if any).
- User is not authenticated. Server responds 403 (Forbidden).
- Upload has expired. Server responds 410 (Gone).
upload_id
does not match any upload. Server responds 404 (Not found).- No chunk file is found in the indicated key. Server responds 400 (Bad request).
- Request does not contain
Content-Range
header. Server responds 400 (Bad request). - Offsets does not match. Server responds 400 (Bad request).
md5
checksums does not match. Server responds 400 (Bad request).
Add any of these variables into your project settings to override them.
- How long after creation the upload will expire.
- Default:
datetime.timedelta(days=1)
- Path where uploading files will be stored until completion.
- Default:
'chunked_uploads/%Y/%m/%d'
- Storage system (should be a class).
- Default:
None
(use default storage system)
- Boolean that defines if the
ChunkedUpload
model will be abstract or not (what does abstract model mean?). - Default:
True
- Function used to encode response data. Receives a dict and returns a string.
- Default:
DjangoJSONEncoder().encode
- Mimetype for the response data.
- Default:
'application/json'
If you find any bug or you want to propose a new feature, please use the issues tracker. I'll be happy to help you! :-)