Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 2 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 (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T16:33:43.000Z (11 months ago)
- Last Synced: 2024-03-15T15:07:44.678Z (11 months ago)
- Topics: django, django-rest-framework, library, tus, tus-protocol
- Language: Python
- Size: 97.7 KB
- Stars: 23
- Watchers: 1
- Forks: 27
- Open Issues: 3
-
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/actionsA 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) $ toxCredits
-------Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage