Skip to main content

django-tus

https://badge.fury.io/py/django-tus.png https://travis-ci.org/alican/django-tus.png?branch=master

Django app implementing server side of tus protocol to powering resumable file uploads for django projects.

Supported Django/Python Versions

Django 2.2.x LTS and Django 3.0.x, 3.1.x

Python > 3.5

Documentation

The full documentation is at https://django-tus.readthedocs.org.

Example project

This example django project includes a javascript TUS demo client and implements django-tus as tus server:: https://github.com/alican/django-tus-example/

Quickstart

Install django-tus:

pip install django-tus

Add ‘django_tus’ to your INSTALLED_APPS setting.:

INSTALLED_APPS = (
...
'django_tus',
)

Add following urls to your urls.py.:

path('upload/', TusUpload.as_view(), name='tus_upload'),
path('upload/<uuid:resource_id>', TusUpload.as_view(), name='tus_upload_chunks'),

Configure and add this settings in your settings.py:

TUS_UPLOAD_DIR = os.path.join(BASE_DIR, 'tus_upload')
TUS_DESTINATION_DIR = os.path.join(BASE_DIR, 'media', 'uploads')
TUS_FILE_NAME_FORMAT = 'increment'  # Other options are: 'random-suffix', 'random', 'keep'
TUS_EXISTING_FILE = 'error'  #  Other options are: 'overwrite',  'error', 'rename'

Django has a setting for maximal memory size for uploaded files. This setting needs to be higher than the chunksize of the tus client:

DATA_UPLOAD_MAX_MEMORY_SIZE = 5242880

Todo

  • More Tus-Extensions

Running Tests

Activate your virtual env, then install the testing requirements with pip install -r requirements_test.txt.

Run the tests with pytest.

You can even generate a coverage report with pytest –cov=django_tus –cov-report=html.

You can run tox to test against multiple Python and Django versions.

Credits

MIT License

Copyright (c) 2020, Alican Toprak

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for django-tus 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-tus 0.5.0
File Size Uploaded Provenance Actions
django-tus-0.5.0.tar.gz 10.2 kB Without provenance Details for django-tus-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-tus 0.5.0
File Interpreter ABI Platform Actions
django_tus-0.5.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for django_tus-0.5.0-py2.py3-none-any.whl

Total release size: 21.1 kB

Release files / django-tus-0.5.0.tar.gz

Download URL django-tus-0.5.0.tar.gz
Size 10.2 kB
Tags Source
SHA-256 checksum
How to use checksums
9b9e8c69a9304993d840856403af1c76497408f4d9132571b974a7c0a0889310
BLAKE2b-256 checksum
How to use checksums
a0bf87910d1293fc43aed2fa8c109a87d7dc47fcb7c08430421207a85a507043
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.7.6

Release files / django_tus-0.5.0-py2.py3-none-any.whl

Download URL django_tus-0.5.0-py2.py3-none-any.whl
Size 10.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f1470e467735b74b008bd4758c113441fec8b45b26b3bd340415a8a61c9bf280
BLAKE2b-256 checksum
How to use checksums
d49d1176601b35b8dc7a4c4144f08b58245ac25b8e80ed844f1a819fb83af990
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.7.6

Security for django-tus 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page