%global _empty_manifest_terminate_build 0 Name: python-drf-chunked-upload Version: 0.5.1 Release: 1 Summary: Upload large files to Django REST Framework in multiple chunks, with the ability to resume if the upload is interrupted. License: MIT-Zero URL: https://github.com/jkeifer/drf-chunked-upload Source0: https://mirrors.aliyun.com/pypi/web/packages/75/7e/c50923c41a94c9884bbc85c9c4e725f8477495c36582c2a87e69221f7eac/drf-chunked-upload-0.5.1.tar.gz BuildArch: noarch Requires: python3-Django Requires: python3-djangorestframework %description # drf-chunked-upload [![build-status-image]][build-status] [![coverage-status-image]][codecov] [![pypi-version]][pypi] This simple django app enables users to upload large files to Django Rest Framework in multiple chunks, with the ability to resume if the upload is interrupted. This app is based to a large degree on the work of [Julio Malegria][github-jm], specifically his [django-chunked-upload app][dcu]. License: [MIT-Zero][lic]. ## Installation Install via pip: ``` pip install drf-chunked-upload ``` And then add it to your Django `INSTALLED_APPS`: ``` INSTALLED_APPS = ( # ... 'drf_chunked_upload', ) ``` ## Typical usage 1. An initial PUT request is sent to the url linked to `ChunkedUploadView` (or any subclass) with the first chunk of the file. The name of the chunk file can be overriden in the view (class attribute `field_name`). Example: ``` python r = requests.put( upload_url, headers={ "Content-Range": "bytes {}-{}/{}".format(index, index + size - 1, total), }, data={"filename": build_file}, files={'file': chunk_data}, ) ``` 2. In return, the server will respond with the `url` of the upload, and the current `offset`. Example: ``` { 'id': 'f64ebd67-83a3-45b6-8acd-c749ea1ed4cd' 'url': 'https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd', 'file': 'https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd.part', 'filename': 'example.bin', 'offset': 10000, `created_at`: '2021-05-18T17:12:50.318718Z', 'status': 1, 'completed_at': None, 'user': 1 } ``` 3. Repeatedly PUT subsequent chunks to the `url` returned from the server. Example: ``` python # PUT to https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd upload_url = "https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd" r = requests.put( upload_url, headers={ "Content-Range": "bytes {}-{}/{}".format(index, index + size - 1, total), }, data={"filename": build_file}, files={'file': chunk_data}, ) ``` 4. Server will continue responding with the `url` and current `offset`. 5. Finally, when upload is completed, POST a request to the returned `url`. This request must include the checksum (hex) of the entire file. Example: ``` python # POST to https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd upload_url = "https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd" r = requests.post(upload_url, data={"md5": "fc3ff98e8c6a0d3087d515c0473f8677"}) ``` 6. If everything is OK, server will response with status code 200 and the data returned in the method `get_response_data` (if any). 7. If you want to upload a file as a single chunk, this is also possible! Simply make the first request a POST and include the checksum digest for the file. You don\'t need to include the `Content-Range` header if uploading a whole file. **Possible error responses:** - Upload has expired. Server responds 410 (Gone). - `id` does not match any upload. Server responds 404 (Not found). - No chunk file is found in the indicated key. Server responds 400 (Bad request). - Request does not contain `Content-Range` header. Server responds 400 (Bad request). - Size of file exceeds limit (if specified). Server responds 400 (Bad request). - Offsets do not match. Server responds 400 (Bad request). - Checksums do not match. Server responds 400 (Bad request). ## Settings Add any of these variables into your project settings to override them. `DRF_CHUNKED_UPLOAD_EXPIRATION_DELTA` - How long after creation the upload will expire. - Default: `datetime.timedelta(days=1)` `DRF_CHUNKED_UPLOAD_PATH` - Path where uploaded files will be stored. - Default: `'chunked_uploads/%Y/%m/%d'` `DRF_CHUNKED_UPLOAD_CHECKSUM` - The type of checksum to use when verifying checksums. Options include anything supported by Python\'s hashlib (md5, sha1, sha256, etc) - Default: `'md5'` `DRF_CHUNKED_UPLOAD_COMPLETE_EXT` - Extension to use for completed uploads. Uploads will be renamed using this extension on completion, unless this extension matched DRF_CHUNKED_UPLOAD_INCOMPLETE_EXT. - Default: `'.done'` `DRF_CHUNKED_UPLOAD_INCOMPLETE_EXT` - Extension for in progress upload files. - Default: `'.part'` `DRF_CHUNKED_UPLOAD_STORAGE_CLASS` - Storage system (should be a class) - Default: `None` (use default storage system) `DRF_CHUNKED_UPLOAD_USER_RESTRICED` - Boolean that determines whether only the user who created an upload can view/continue an upload. - Default: `True` `DRF_CHUNKED_UPLOAD_ABSTRACT_MODEL` - Boolean that defines if the `ChunkedUpload` model will be abstract or not ([what does abstract model mean?][abstract-model]). - Default: `True` `DRF_CHUNKED_UPLOAD_MAX_BYTES` - Max amount of data (in bytes) that can be uploaded. `None` means no limit. - Default: `None` ## Support If you find any bug or you want to propose a new feature, please use the [issues tracker][issues]. Pull requests are also accepted. [build-status-image]: https://github.com/jkeifer/drf-chunked-upload/actions/workflows/main.yml/badge.svg [build-status]: https://github.com/jkeifer/drf-chunked-upload/actions/workflows/main.yml [coverage-status-image]: https://img.shields.io/codecov/c/github/jkeifer/drf-chunked-upload/master.svg [codecov]: https://codecov.io/github/jkeifer/drf-chunked-upload?branch=master [pypi-version]: https://img.shields.io/pypi/v/drf-chunked-upload.svg [pypi]: https://pypi.org/project/drf-chunked-upload/ [github-jm]: https://github.com/juliomalegria [dcu]: https://github.com/juliomalegria/django-chunked-upload [issues]: https://github.com/jkeifer/drf-chunked-upload/issues [lic]: https://romanrm.net/mit-zero [abstract-model]: https://docs.djangoproject.com/en/3.2/topics/db/models/#abstract-base-classes %package -n python3-drf-chunked-upload Summary: Upload large files to Django REST Framework in multiple chunks, with the ability to resume if the upload is interrupted. Provides: python-drf-chunked-upload BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-drf-chunked-upload # drf-chunked-upload [![build-status-image]][build-status] [![coverage-status-image]][codecov] [![pypi-version]][pypi] This simple django app enables users to upload large files to Django Rest Framework in multiple chunks, with the ability to resume if the upload is interrupted. This app is based to a large degree on the work of [Julio Malegria][github-jm], specifically his [django-chunked-upload app][dcu]. License: [MIT-Zero][lic]. ## Installation Install via pip: ``` pip install drf-chunked-upload ``` And then add it to your Django `INSTALLED_APPS`: ``` INSTALLED_APPS = ( # ... 'drf_chunked_upload', ) ``` ## Typical usage 1. An initial PUT request is sent to the url linked to `ChunkedUploadView` (or any subclass) with the first chunk of the file. The name of the chunk file can be overriden in the view (class attribute `field_name`). Example: ``` python r = requests.put( upload_url, headers={ "Content-Range": "bytes {}-{}/{}".format(index, index + size - 1, total), }, data={"filename": build_file}, files={'file': chunk_data}, ) ``` 2. In return, the server will respond with the `url` of the upload, and the current `offset`. Example: ``` { 'id': 'f64ebd67-83a3-45b6-8acd-c749ea1ed4cd' 'url': 'https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd', 'file': 'https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd.part', 'filename': 'example.bin', 'offset': 10000, `created_at`: '2021-05-18T17:12:50.318718Z', 'status': 1, 'completed_at': None, 'user': 1 } ``` 3. Repeatedly PUT subsequent chunks to the `url` returned from the server. Example: ``` python # PUT to https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd upload_url = "https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd" r = requests.put( upload_url, headers={ "Content-Range": "bytes {}-{}/{}".format(index, index + size - 1, total), }, data={"filename": build_file}, files={'file': chunk_data}, ) ``` 4. Server will continue responding with the `url` and current `offset`. 5. Finally, when upload is completed, POST a request to the returned `url`. This request must include the checksum (hex) of the entire file. Example: ``` python # POST to https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd upload_url = "https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd" r = requests.post(upload_url, data={"md5": "fc3ff98e8c6a0d3087d515c0473f8677"}) ``` 6. If everything is OK, server will response with status code 200 and the data returned in the method `get_response_data` (if any). 7. If you want to upload a file as a single chunk, this is also possible! Simply make the first request a POST and include the checksum digest for the file. You don\'t need to include the `Content-Range` header if uploading a whole file. **Possible error responses:** - Upload has expired. Server responds 410 (Gone). - `id` does not match any upload. Server responds 404 (Not found). - No chunk file is found in the indicated key. Server responds 400 (Bad request). - Request does not contain `Content-Range` header. Server responds 400 (Bad request). - Size of file exceeds limit (if specified). Server responds 400 (Bad request). - Offsets do not match. Server responds 400 (Bad request). - Checksums do not match. Server responds 400 (Bad request). ## Settings Add any of these variables into your project settings to override them. `DRF_CHUNKED_UPLOAD_EXPIRATION_DELTA` - How long after creation the upload will expire. - Default: `datetime.timedelta(days=1)` `DRF_CHUNKED_UPLOAD_PATH` - Path where uploaded files will be stored. - Default: `'chunked_uploads/%Y/%m/%d'` `DRF_CHUNKED_UPLOAD_CHECKSUM` - The type of checksum to use when verifying checksums. Options include anything supported by Python\'s hashlib (md5, sha1, sha256, etc) - Default: `'md5'` `DRF_CHUNKED_UPLOAD_COMPLETE_EXT` - Extension to use for completed uploads. Uploads will be renamed using this extension on completion, unless this extension matched DRF_CHUNKED_UPLOAD_INCOMPLETE_EXT. - Default: `'.done'` `DRF_CHUNKED_UPLOAD_INCOMPLETE_EXT` - Extension for in progress upload files. - Default: `'.part'` `DRF_CHUNKED_UPLOAD_STORAGE_CLASS` - Storage system (should be a class) - Default: `None` (use default storage system) `DRF_CHUNKED_UPLOAD_USER_RESTRICED` - Boolean that determines whether only the user who created an upload can view/continue an upload. - Default: `True` `DRF_CHUNKED_UPLOAD_ABSTRACT_MODEL` - Boolean that defines if the `ChunkedUpload` model will be abstract or not ([what does abstract model mean?][abstract-model]). - Default: `True` `DRF_CHUNKED_UPLOAD_MAX_BYTES` - Max amount of data (in bytes) that can be uploaded. `None` means no limit. - Default: `None` ## Support If you find any bug or you want to propose a new feature, please use the [issues tracker][issues]. Pull requests are also accepted. [build-status-image]: https://github.com/jkeifer/drf-chunked-upload/actions/workflows/main.yml/badge.svg [build-status]: https://github.com/jkeifer/drf-chunked-upload/actions/workflows/main.yml [coverage-status-image]: https://img.shields.io/codecov/c/github/jkeifer/drf-chunked-upload/master.svg [codecov]: https://codecov.io/github/jkeifer/drf-chunked-upload?branch=master [pypi-version]: https://img.shields.io/pypi/v/drf-chunked-upload.svg [pypi]: https://pypi.org/project/drf-chunked-upload/ [github-jm]: https://github.com/juliomalegria [dcu]: https://github.com/juliomalegria/django-chunked-upload [issues]: https://github.com/jkeifer/drf-chunked-upload/issues [lic]: https://romanrm.net/mit-zero [abstract-model]: https://docs.djangoproject.com/en/3.2/topics/db/models/#abstract-base-classes %package help Summary: Development documents and examples for drf-chunked-upload Provides: python3-drf-chunked-upload-doc %description help # drf-chunked-upload [![build-status-image]][build-status] [![coverage-status-image]][codecov] [![pypi-version]][pypi] This simple django app enables users to upload large files to Django Rest Framework in multiple chunks, with the ability to resume if the upload is interrupted. This app is based to a large degree on the work of [Julio Malegria][github-jm], specifically his [django-chunked-upload app][dcu]. License: [MIT-Zero][lic]. ## Installation Install via pip: ``` pip install drf-chunked-upload ``` And then add it to your Django `INSTALLED_APPS`: ``` INSTALLED_APPS = ( # ... 'drf_chunked_upload', ) ``` ## Typical usage 1. An initial PUT request is sent to the url linked to `ChunkedUploadView` (or any subclass) with the first chunk of the file. The name of the chunk file can be overriden in the view (class attribute `field_name`). Example: ``` python r = requests.put( upload_url, headers={ "Content-Range": "bytes {}-{}/{}".format(index, index + size - 1, total), }, data={"filename": build_file}, files={'file': chunk_data}, ) ``` 2. In return, the server will respond with the `url` of the upload, and the current `offset`. Example: ``` { 'id': 'f64ebd67-83a3-45b6-8acd-c749ea1ed4cd' 'url': 'https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd', 'file': 'https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd.part', 'filename': 'example.bin', 'offset': 10000, `created_at`: '2021-05-18T17:12:50.318718Z', 'status': 1, 'completed_at': None, 'user': 1 } ``` 3. Repeatedly PUT subsequent chunks to the `url` returned from the server. Example: ``` python # PUT to https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd upload_url = "https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd" r = requests.put( upload_url, headers={ "Content-Range": "bytes {}-{}/{}".format(index, index + size - 1, total), }, data={"filename": build_file}, files={'file': chunk_data}, ) ``` 4. Server will continue responding with the `url` and current `offset`. 5. Finally, when upload is completed, POST a request to the returned `url`. This request must include the checksum (hex) of the entire file. Example: ``` python # POST to https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd upload_url = "https://your-host//f64ebd67-83a3-45b6-8acd-c749ea1ed4cd" r = requests.post(upload_url, data={"md5": "fc3ff98e8c6a0d3087d515c0473f8677"}) ``` 6. If everything is OK, server will response with status code 200 and the data returned in the method `get_response_data` (if any). 7. If you want to upload a file as a single chunk, this is also possible! Simply make the first request a POST and include the checksum digest for the file. You don\'t need to include the `Content-Range` header if uploading a whole file. **Possible error responses:** - Upload has expired. Server responds 410 (Gone). - `id` does not match any upload. Server responds 404 (Not found). - No chunk file is found in the indicated key. Server responds 400 (Bad request). - Request does not contain `Content-Range` header. Server responds 400 (Bad request). - Size of file exceeds limit (if specified). Server responds 400 (Bad request). - Offsets do not match. Server responds 400 (Bad request). - Checksums do not match. Server responds 400 (Bad request). ## Settings Add any of these variables into your project settings to override them. `DRF_CHUNKED_UPLOAD_EXPIRATION_DELTA` - How long after creation the upload will expire. - Default: `datetime.timedelta(days=1)` `DRF_CHUNKED_UPLOAD_PATH` - Path where uploaded files will be stored. - Default: `'chunked_uploads/%Y/%m/%d'` `DRF_CHUNKED_UPLOAD_CHECKSUM` - The type of checksum to use when verifying checksums. Options include anything supported by Python\'s hashlib (md5, sha1, sha256, etc) - Default: `'md5'` `DRF_CHUNKED_UPLOAD_COMPLETE_EXT` - Extension to use for completed uploads. Uploads will be renamed using this extension on completion, unless this extension matched DRF_CHUNKED_UPLOAD_INCOMPLETE_EXT. - Default: `'.done'` `DRF_CHUNKED_UPLOAD_INCOMPLETE_EXT` - Extension for in progress upload files. - Default: `'.part'` `DRF_CHUNKED_UPLOAD_STORAGE_CLASS` - Storage system (should be a class) - Default: `None` (use default storage system) `DRF_CHUNKED_UPLOAD_USER_RESTRICED` - Boolean that determines whether only the user who created an upload can view/continue an upload. - Default: `True` `DRF_CHUNKED_UPLOAD_ABSTRACT_MODEL` - Boolean that defines if the `ChunkedUpload` model will be abstract or not ([what does abstract model mean?][abstract-model]). - Default: `True` `DRF_CHUNKED_UPLOAD_MAX_BYTES` - Max amount of data (in bytes) that can be uploaded. `None` means no limit. - Default: `None` ## Support If you find any bug or you want to propose a new feature, please use the [issues tracker][issues]. Pull requests are also accepted. [build-status-image]: https://github.com/jkeifer/drf-chunked-upload/actions/workflows/main.yml/badge.svg [build-status]: https://github.com/jkeifer/drf-chunked-upload/actions/workflows/main.yml [coverage-status-image]: https://img.shields.io/codecov/c/github/jkeifer/drf-chunked-upload/master.svg [codecov]: https://codecov.io/github/jkeifer/drf-chunked-upload?branch=master [pypi-version]: https://img.shields.io/pypi/v/drf-chunked-upload.svg [pypi]: https://pypi.org/project/drf-chunked-upload/ [github-jm]: https://github.com/juliomalegria [dcu]: https://github.com/juliomalegria/django-chunked-upload [issues]: https://github.com/jkeifer/drf-chunked-upload/issues [lic]: https://romanrm.net/mit-zero [abstract-model]: https://docs.djangoproject.com/en/3.2/topics/db/models/#abstract-base-classes %prep %autosetup -n drf-chunked-upload-0.5.1 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-drf-chunked-upload -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Thu Jun 08 2023 Python_Bot - 0.5.1-1 - Package Spec generated