Skip to main content

A Tus (tus.io) library for Django Rest Framework

Project description

https://badge.fury.io/py/drf-tus.svg https://travis-ci.org/dirkmoors/drf-tus.svg?branch=master https://codecov.io/gh/dirkmoors/drf-tus/branch/master/graph/badge.svg

A Tus (tus.io) library for Django Rest Framework

Documentation

The full documentation is at https://drf-tus.readthedocs.io.

Quickstart

Install drf-tus:

pip install drf-tus

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'rest_framework_tus',
    ...
)

Add the middleware to MIDDLEWARE (or MIDDLEWARE_CLASSES for Django < 1.10)

MIDDLEWARE = (
    ...
    'rest_framework_tus.middleware.TusMiddleware',
    ...
)

Add drf-tus’s URL patterns:

urlpatterns = [
    ...
    url(r'^', include('rest_framework_tus.urls', namespace='rest_framework_tus')),
    ...
]

Features

This library implements the following TUS API v1.0.0 protocols:

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

History

1.16 (2017-05-04)

  • Implemented validate_filename handler in TusCreateMixin.

1.15 (2017-04-06)

  • Added missing migration and changed max_length to 255 for model Upload’s attribute uploaded_file

1.14 (2017-03-30)

  • Updated default behaviour of the get_header handler in TusMiddleware.

1.13 (2017-03-30)

  • Implemented handler for retrieving request headers in TusMiddleware.

1.12 (2017-03-10)

  • Updated validate_chunk signature

1.11 (2017-03-10)

  • Implemented validate_chunk handler method in TusPatchMixin

  • Implemented validate_success_headers handler method in TusCreateMixin

1.10 (2017-03-09)

  • Disabled chunk writing to disk

1.9 (2017-03-09)

  • Introduced TusUploadStreamParser

1.8 (2017-03-09)

  • Introduced setting to include serializer data in respons body

1.7 (2017-03-09)

  • Bugfixes

1.6 (2017-03-09)

  • Bugfixes

1.5 (2017-03-09)

  • Updated middleware, removed required header (bug!)

1.4 (2017-03-09)

  • Initial migration

1.3 (2017-03-09)

  • Renamed some parameters / classes

1.2 (2017-03-09)

  • Cleanup repository.

1.1 (2017-03-09)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

drf-tus-1.16.tar.gz (16.5 kB view hashes)

Uploaded Source

Built Distribution

drf_tus-1.16-py2.py3-none-any.whl (21.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page