=============================
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
Raw data
{
"_id": null,
"home_page": null,
"name": "drf-tus",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "drf-tus, tus, django, rest, framework, django-rest-framework",
"author": null,
"author_email": "Dirk Moors <dirkmoors@gmail.com>",
"download_url": null,
"platform": null,
"description": "=============================\ndrf-tus\n=============================\n\n.. image:: https://badge.fury.io/py/drf-tus.svg\n :target: https://badge.fury.io/py/drf-tus\n\n.. image:: https://github.com/dirkmoors/drf-tus/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/dirkmoors/drf-tus/actions\n\nA Tus (tus.io) library for Django Rest Framework\n\nDocumentation\n-------------\n\nThe full documentation is at https://drf-tus.readthedocs.io.\n\nQuickstart\n----------\n\nInstall drf-tus::\n\n pip install drf-tus\n\nAdd it to your `INSTALLED_APPS`:\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...\n \"rest_framework_tus\",\n ...\n )\n\nAdd the middleware to `MIDDLEWARE`:\n\n.. code-block:: python\n\n MIDDLEWARE = (\n ...\n \"rest_framework_tus.middleware.TusMiddleware\",\n ...\n )\n\nAdd URL patterns for drf-tus:\n\n.. code-block:: python\n\n urlpatterns = [\n ...\n path(r\"^\", include(\"rest_framework_tus.urls\", namespace=\"rest_framework_tus\")),\n ...\n ]\n\nFeatures\n--------\n\nThis library implements the following TUS API v1.0.0 protocols:\n\n* Core Protocol (http://tus.io/protocols/resumable-upload.html#core-protocol)\n* Creation Protocol (http://tus.io/protocols/resumable-upload.html#creation)\n* Expiration Protocol (http://tus.io/protocols/resumable-upload.html#expiration)\n* Checksum Protocol (http://tus.io/protocols/resumable-upload.html#checksum)\n* Termination Protocol (http://tus.io/protocols/resumable-upload.html#termination)\n\nRunning Tests\n-------------\n\nDoes the code actually work?\n\n::\n\n source <YOURVIRTUALENV>/bin/activate\n (myenv) $ pip install tox\n (myenv) $ tox\n\nCredits\n-------\n\nTools used in rendering this package:\n\n* Cookiecutter_\n* `cookiecutter-djangopackage`_\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Tus (tus.io) library for Django Rest Framework",
"version": "2.0.2",
"project_urls": {
"changelog": "https://github.com/dirkmoors/drf-tus/blob/master/HISTORY.rst",
"homepage": "https://github.com/dirkmoors/drf-tus"
},
"split_keywords": [
"drf-tus",
" tus",
" django",
" rest",
" framework",
" django-rest-framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d57c8cbf6341c6b649c7235715c91cf906ff232c53f1d71f310c06d7371625a0",
"md5": "89062146ffb0a6fbd172769842929bdb",
"sha256": "c94faa68a8e9ee889ec1c8e054226e0ea13b332ca64087df519f6e5551c30c72"
},
"downloads": -1,
"filename": "drf_tus-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89062146ffb0a6fbd172769842929bdb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20041,
"upload_time": "2024-05-27T12:21:48",
"upload_time_iso_8601": "2024-05-27T12:21:48.835842Z",
"url": "https://files.pythonhosted.org/packages/d5/7c/8cbf6341c6b649c7235715c91cf906ff232c53f1d71f310c06d7371625a0/drf_tus-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-27 12:21:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dirkmoors",
"github_project": "drf-tus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "djangorestframework",
"specs": [
[
">=",
"3.14.0"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
">=",
"2.8.2"
]
]
}
],
"tox": true,
"lcname": "drf-tus"
}
JSON
