https://github.com/dirkmoors/drf-tus

A Tus (tus.io) library for Django Rest Framework
https://github.com/dirkmoors/drf-tus

django django-rest-framework library tus tus-protocol

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dirkmoors/drf-tus
• Owner: dirkmoors
• License: mit
• Created: 2017-03-08T16:55:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-27T12:18:48.000Z (over 1 year ago)
• Last Synced: 2025-04-15T03:54:52.302Z (6 months ago)
• Topics: django, django-rest-framework, library, tus, tus-protocol
• Language: Python
• Size: 102 KB
• Stars: 26
• Watchers: 1
• Forks: 27
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
=============================

drf-tus

=============================

.. image:: https://badge.fury.io/py/drf-tus.svg

    :target: https://badge.fury.io/py/drf-tus

.. image:: https://github.com/dirkmoors/drf-tus/actions/workflows/ci.yml/badge.svg

    :target: https://github.com/dirkmoors/drf-tus/actions

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`:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        "rest_framework_tus",

        ...

    )

Add the middleware to `MIDDLEWARE`:

.. code-block:: python

    MIDDLEWARE = (

        ...

        "rest_framework_tus.middleware.TusMiddleware",

        ...

    )

Add URL patterns for drf-tus:

.. code-block:: python

    urlpatterns = [

        ...

        path(r"^", include("rest_framework_tus.urls", namespace="rest_framework_tus")),

        ...

    ]

Features

--------

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

* Core Protocol (http://tus.io/protocols/resumable-upload.html#core-protocol)

* Creation Protocol (http://tus.io/protocols/resumable-upload.html#creation)

* Expiration Protocol (http://tus.io/protocols/resumable-upload.html#expiration)

* Checksum Protocol (http://tus.io/protocols/resumable-upload.html#checksum)

* Termination Protocol (http://tus.io/protocols/resumable-upload.html#termination)

Running Tests

-------------

Does the code actually work?

::

    source /bin/activate

    (myenv) $ pip install tox

    (myenv) $ tox

Credits

-------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage