=============================
drf-tus
=============================
.. image:: https://badge.fury.io/py/drf-tus.svg
:target: https://badge.fury.io/py/drf-tus
.. image:: https://travis-ci.org/dirkmoors/drf-tus.svg?branch=master
:target: https://travis-ci.org/dirkmoors/drf-tus
.. image:: https://codecov.io/gh/dirkmoors/drf-tus/branch/master/graph/badge.svg
:target: https://codecov.io/gh/dirkmoors/drf-tus
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` (or `MIDDLEWARE_CLASSES` for Django < 1.10)
.. code-block:: python
MIDDLEWARE = (
...
'rest_framework_tus.middleware.TusMiddleware',
...
)
Add drf-tus's URL patterns:
.. code-block:: python
urlpatterns = [
...
url(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
History
-------
1.21.2 (2018-09-04)
+++++++++++++++++++
* Fixed Django compatibility
1.21.1 (2018-08-01)
+++++++++++++++++++
* Fixed failing travis build
1.21 (2018-08-01)
+++++++++++++++++
* Updated Django dependency and dropped support for Python 3.3.x (https://github.com/dirkmoors/drf-tus/pull/9)
1.20 (2018-02-12)
+++++++++++++++++
* Implemented per-view max file size setting (https://github.com/dirkmoors/drf-tus/pull/8)
1.19 (2018-02-08)
+++++++++++++++++
* Fixed bug that occured when pausing uploads (https://github.com/dirkmoors/drf-tus/pull/7)
1.18 (2018-02-08)
+++++++++++++++++
* Make the metadata 'filename' key a setting. (https://github.com/dirkmoors/drf-tus/pull/2)
* Switch from (Positive)IntegerField to BigIntegerField for the upload_length and upload_offset fields (https://github.com/dirkmoors/drf-tus/pull/3)
* Increase Django version support up to 1.11 (https://github.com/dirkmoors/drf-tus/pull/4)
* Fix unicode errors (https://github.com/dirkmoors/drf-tus/pull/5)
* Updated travis configuration
1.17 (2017-05-10)
+++++++++++++++++
* Exchanged use of `base64.encodebytes` to `base64.b64encode`.
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/sicksid/drf-tus.git",
"name": "sicksid-drf-tus",
"maintainer": "",
"docs_url": null,
"requires_python": null,
"maintainer_email": "",
"keywords": "drf-tus,tus,django,rest,framework,django-rest-framework",
"author": "Dirk Moors",
"author_email": "dirkmoors@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/07/b1/ad5647cd9f7136a595edb3476fe52b6af6d483ecd5ecd0c45285eb35252c/sicksid-drf-tus-1.22.0.tar.gz",
"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://travis-ci.org/dirkmoors/drf-tus.svg?branch=master\n :target: https://travis-ci.org/dirkmoors/drf-tus\n\n.. image:: https://codecov.io/gh/dirkmoors/drf-tus/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/dirkmoors/drf-tus\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` (or `MIDDLEWARE_CLASSES` for Django < 1.10)\n\n.. code-block:: python\n\n MIDDLEWARE = (\n ...\n 'rest_framework_tus.middleware.TusMiddleware',\n ...\n )\n\nAdd drf-tus's URL patterns:\n\n.. code-block:: python\n\n urlpatterns = [\n ...\n url(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\n\n\n\nHistory\n-------\n\n1.21.2 (2018-09-04)\n+++++++++++++++++++\n\n* Fixed Django compatibility\n\n1.21.1 (2018-08-01)\n+++++++++++++++++++\n\n* Fixed failing travis build\n\n1.21 (2018-08-01)\n+++++++++++++++++\n\n* Updated Django dependency and dropped support for Python 3.3.x (https://github.com/dirkmoors/drf-tus/pull/9)\n\n1.20 (2018-02-12)\n+++++++++++++++++\n\n* Implemented per-view max file size setting (https://github.com/dirkmoors/drf-tus/pull/8)\n\n1.19 (2018-02-08)\n+++++++++++++++++\n\n* Fixed bug that occured when pausing uploads (https://github.com/dirkmoors/drf-tus/pull/7)\n\n1.18 (2018-02-08)\n+++++++++++++++++\n\n* Make the metadata 'filename' key a setting. (https://github.com/dirkmoors/drf-tus/pull/2)\n* Switch from (Positive)IntegerField to BigIntegerField for the upload_length and upload_offset fields (https://github.com/dirkmoors/drf-tus/pull/3)\n* Increase Django version support up to 1.11 (https://github.com/dirkmoors/drf-tus/pull/4)\n* Fix unicode errors (https://github.com/dirkmoors/drf-tus/pull/5)\n* Updated travis configuration\n\n1.17 (2017-05-10)\n+++++++++++++++++\n\n* Exchanged use of `base64.encodebytes` to `base64.b64encode`.\n\n1.16 (2017-05-04)\n+++++++++++++++++\n\n* Implemented `validate_filename` handler in `TusCreateMixin`.\n\n1.15 (2017-04-06)\n+++++++++++++++++\n\n* Added missing migration and changed max_length to 255 for model `Upload`'s attribute `uploaded_file`\n\n1.14 (2017-03-30)\n+++++++++++++++++\n\n* Updated default behaviour of the `get_header` handler in `TusMiddleware`.\n\n1.13 (2017-03-30)\n+++++++++++++++++\n\n* Implemented handler for retrieving request headers in `TusMiddleware`.\n\n1.12 (2017-03-10)\n+++++++++++++++++\n\n* Updated `validate_chunk` signature\n\n1.11 (2017-03-10)\n+++++++++++++++++\n\n* Implemented `validate_chunk` handler method in TusPatchMixin\n* Implemented `validate_success_headers` handler method in TusCreateMixin\n\n1.10 (2017-03-09)\n+++++++++++++++++\n\n* Disabled chunk writing to disk\n\n1.9 (2017-03-09)\n++++++++++++++++\n\n* Introduced TusUploadStreamParser\n\n1.8 (2017-03-09)\n++++++++++++++++\n\n* Introduced setting to include serializer data in respons body\n\n1.7 (2017-03-09)\n++++++++++++++++\n\n* Bugfixes\n\n1.6 (2017-03-09)\n++++++++++++++++\n\n* Bugfixes\n\n1.5 (2017-03-09)\n++++++++++++++++\n\n* Updated middleware, removed required header (bug!)\n\n1.4 (2017-03-09)\n++++++++++++++++\n\n* Initial migration\n\n1.3 (2017-03-09)\n++++++++++++++++\n\n* Renamed some parameters / classes\n\n1.2 (2017-03-09)\n++++++++++++++++\n\n* Cleanup repository.\n\n\n1.1 (2017-03-09)\n++++++++++++++++\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Tus (tus.io) library for Django Rest Framework (copied for now from",
"version": "1.22.0",
"split_keywords": [
"drf-tus",
"tus",
"django",
"rest",
"framework",
"django-rest-framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "429600665348ade8d0fbd39098a38be3",
"sha256": "dda2e36fd174958b9a62d3c9e65b68c0e4da3d1642761036e3cbbcf810c6ab9a"
},
"downloads": -1,
"filename": "sicksid_drf_tus-1.22.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "429600665348ade8d0fbd39098a38be3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 23645,
"upload_time": "2022-12-17T08:02:55",
"upload_time_iso_8601": "2022-12-17T08:02:55.882284Z",
"url": "https://files.pythonhosted.org/packages/09/74/96770659d08dd51bd31f3c56a0f755932f58f38a80be3f8831c0c279b194/sicksid_drf_tus-1.22.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "96dd87fe588f4924f3492647d3cf5a7f",
"sha256": "0bb56b5791b70a968041a639968c74a193fc4edadcaadf32adcc848af7068a7c"
},
"downloads": -1,
"filename": "sicksid-drf-tus-1.22.0.tar.gz",
"has_sig": false,
"md5_digest": "96dd87fe588f4924f3492647d3cf5a7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18895,
"upload_time": "2022-12-17T08:02:57",
"upload_time_iso_8601": "2022-12-17T08:02:57.571752Z",
"url": "https://files.pythonhosted.org/packages/07/b1/ad5647cd9f7136a595edb3476fe52b6af6d483ecd5ecd0c45285eb35252c/sicksid-drf-tus-1.22.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-17 08:02:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sicksid",
"github_project": "drf-tus.git",
"lcname": "sicksid-drf-tus"
}
JSON
