Metadata-Version: 2.4
Name: drf-tus
Version: 2.0.3
Summary: A Tus (tus.io) library for Django Rest Framework
Author-email: Dirk Moors <dirkmoors@gmail.com>
License: MIT
Project-URL: homepage, https://github.com/dirkmoors/drf-tus
Project-URL: changelog, https://github.com/dirkmoors/drf-tus/blob/master/HISTORY.rst
Keywords: drf-tus,tus,django,rest,framework,django-rest-framework
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Framework :: Django :: 5.1
Classifier: Framework :: Django :: 6.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: Django<7.0,>=3.2
Requires-Dist: djangorestframework>=3.14.0
Requires-Dist: jsonfield>=2.0.0
Requires-Dist: django-fsm==2.8.1
Requires-Dist: six>=1.11.0
Dynamic: license-file

=============================
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 <YOURVIRTUALENV>/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
