Upload large files to Django in multiple chunks, with the ability to resume if the upload is interrupted.
Project description
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.
License: MIT-Zero.
Installation
NEW: This module is now in PyPI! Install via pip:
pip install django-chunked-upload
And then add it to your Django INSTALLED_APPS:
INSTALLED_APPS = (
# ...
'chunked_upload',
)Typical usage
An initial POST request is sent to the url linked to ChunkedUploadView (or any subclass) with the first chunk of the file. The name of the chunk file can be overriden in the view (class attribute field_name). Example:
{"my_file": <File>}
In return, server with response with the upload_id, the current offset 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 to ChunkedUploadView (or any subclass). Example:
{
"upload_id": "5230ec1f59d1485d9d7974b853802e31",
"my_file": <File>
}
Server will continue responding with the upload_id, the current offset 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 the upload_id and the md5 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).
Possible error responses:
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).
Size of file exceeds limit (if specified). Server responds 400 (Bad request).
Offsets does not match. Server responds 400 (Bad request).
md5 checksums does not match. Server responds 400 (Bad request).
Settings
Add any of these variables into your project settings to override them.
CHUNKED_UPLOAD_EXPIRATION_DELTA
How long after creation the upload will expire.
Default: datetime.timedelta(days=1)
CHUNKED_UPLOAD_PATH
Path where uploading files will be stored until completion.
Default: 'chunked_uploads/%Y/%m/%d'
CHUNKED_UPLOAD_STORAGE_CLASS
Storage system (should be a class)
Default: None (use default storage system)
CHUNKED_UPLOAD_ABSTRACT_MODEL
Boolean that defines if the ChunkedUpload model will be abstract or not (what does abstract model mean?)
Default: True
CHUNKED_UPLOAD_ENCODER
Function used to encode response data. Receives a dict and returns a string
Default: DjangoJSONEncoder().encode
CHUNKED_UPLOAD_MIMETYPE
Mimetype for the response data.
Default: 'application/json'
CHUNKED_UPLOAD_MAX_BYTES
Max amount of data (in bytes) that can be uploaded. None means no limit
Default: None
Support
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! :-)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-chunked-upload-1.0.2.tar.gz.
File metadata
- Download URL: django-chunked-upload-1.0.2.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c24b1a7a41387d09b5e68b56e80c8f57a8b7b3dd370038e7a5f0d9d931913935 |
|
| MD5 | a5a9e7b0e8ff03c503fb132ee3337987 |
|
| BLAKE2b-256 | be57b4e79ff25ffe1c32a6685f6cdaf8eb1e00fab22fa3093d4322b0368e49ce |
