{"id":24060999,"url":"https://github.com/thewebscraping/django-chunk-file-upload","last_synced_at":"2025-04-23T07:53:08.268Z","repository":{"id":254118958,"uuid":"833874223","full_name":"thewebscraping/django-chunk-file-upload","owner":"thewebscraping","description":"Django Chunk File Upload is an alternative utility that helps you easily Django's chunk, drag and drop file uploads.","archived":false,"fork":false,"pushed_at":"2025-04-15T12:50:41.000Z","size":517,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T13:04:57.055Z","etag":null,"topics":["ajax","django","django-chunk-file-upload","django-chunk-upload","django-chunked-upload","django-drag-and-drop-file","django-dropzone","django-file","django-file-manager","django-file-upload","drag-and-drop","drag-drop","jquery","jquery-ajax","python"],"latest_commit_sha":null,"homepage":"https://github.com/thewebscraping/django-chunk-file-upload","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thewebscraping.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-26T00:15:32.000Z","updated_at":"2025-04-15T12:50:44.000Z","dependencies_parsed_at":"2024-08-28T03:53:29.338Z","dependency_job_id":null,"html_url":"https://github.com/thewebscraping/django-chunk-file-upload","commit_stats":null,"previous_names":["thewebscraping/django-chunk-file-upload"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thewebscraping%2Fdjango-chunk-file-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thewebscraping%2Fdjango-chunk-file-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thewebscraping%2Fdjango-chunk-file-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thewebscraping%2Fdjango-chunk-file-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thewebscraping","download_url":"https://codeload.github.com/thewebscraping/django-chunk-file-upload/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250395159,"owners_count":21423375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ajax","django","django-chunk-file-upload","django-chunk-upload","django-chunked-upload","django-drag-and-drop-file","django-dropzone","django-file","django-file-manager","django-file-upload","drag-and-drop","drag-drop","jquery","jquery-ajax","python"],"created_at":"2025-01-09T07:16:02.741Z","updated_at":"2025-04-23T07:53:08.249Z","avatar_url":"https://github.com/thewebscraping.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Django Chunk File Upload\n\nDjango Chunk File Upload is an alternative utility that helps you easily edit Django's chunked, drag and drop file uploads.\n\n\u003cimg src=\"https://i.ibb.co/9y2SgmS/f-P5-Or-Gkxk0-Ynj00ct-G.webp\" alt=\"f-P5-Or-Gkxk0-Ynj00ct-G\"\u003e\n\nFeatures\n----------\n- Multiple file uploads.\n- Drag and Drop UI.\n- MD5 checksum file: check, validate, handle duplicate files.\n- Chunked uploads: optimizing large file transfers.\n- Prevent uploading existing files with MD5 checksum.\n- Easy to use any models.\n- Image optimizer, resizer, auto convert to webp (supported webp, png, jpg, jpeg).\n- Permissions.\n\n\nQuickstart\n----------\n\nInstall Django Chunk File Upload:\n```shell\npip install git+https://github.com/thewebscraping/django-chunk-file-upload.git\n```\n\nPypi:\n```shell\npip install django-chunk-file-upload\n```\n\nAdd it to your `settings.py`:\n\n```python\nINSTALLED_APPS = [\n    'django_chunk_file_upload',\n]\n```\n\nAdd it to your `urls.py`:\n\n\n```python\nfrom django.urls import path, include\n\nurlpatterns = [\n    path(\"file-manager/\", include(\"django_chunk_file_upload.urls\")),\n]\n```\n\nRun Demo\n\nDemo URL: http://127.0.0.1:8000/file-manager/uploads/\n```shell\ncd examples\npython manage.py migrate\npython manage.py runserver\n```\n\nChange default config: `settings.py`\n\n```python\nDJANGO_CHUNK_FILE_UPLOAD = {\n    \"chunk_size\": 1024 * 1024 * 2,  # # Custom chunk size upload (default: 2MB).\n    \"upload_to\": \"uploads/%Y/%m/%d\",  # Custom upload folder.\n    \"is_metadata_storage\": True,  # Save file metadata,\n    \"remove_file_on_update\": True,\n    \"optimize\": True,\n    \"image_optimizer\": {\n        \"quality\": 82,\n        \"compress_level\": 9,\n        \"max_width\": 1024,\n        \"max_height\": 720,\n        \"to_webp\": True,  # Force convert image to webp type.\n        \"remove_origin\": True,  # Force to delete original image after optimization.\n    },\n    \"permission_classes\": (\"django_chunk_file_upload.permissions.AllowAny\",),  # default: IsAuthenticated\n    # \"js\": (\n    #     \"https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js\",\n    #     \"https://cdnjs.cloudflare.com/ajax/libs/spark-md5/3.0.2/spark-md5.min.js\",\n    #     \"https://cdnjs.cloudflare.com/ajax/libs/toastr.js/latest/toastr.min.js\",\n    # ),  # custom js, use cdn.\n    # \"css\": (\"custom.css\",),  # custom your css path.\n}\n\n```\n\nCustom Your Models\n----------\n\nmodels.py\n\n```python\nfrom django.db import models\nfrom django_chunk_file_upload.models import FileManagerMixin\n\n\nclass Tag(models.Model):\n    name = models.CharField(max_length=255)\n\n\nclass YourModel(FileManagerMixin):\n    tags = models.ManyToManyField(Tag)\n    custom_field = models.CharField(max_length=255)\n\n```\n\nforms.py\n\n```python\nfrom django_chunk_file_upload.forms import ChunkedUploadFileForm\nfrom .models import YourModel\n\n\nclass YourForm(ChunkedUploadFileForm):\n    class Meta:\n        model = YourModel\n        fields = \"__all__\"\n```\n\nviews.py\n\nAccepted methods: GET, POST, DELETE (UPDATE, PUT does not work with FormData).\n```python\nfrom django_chunk_file_upload.views import ChunkedUploadView\nfrom django_chunk_file_upload.typed import File\nfrom django_chunk_file_upload.permissions import IsAuthenticated\nfrom .forms import YourForm\n\n\nclass CustomChunkedUploadView(ChunkedUploadView):\n    form_class = YourForm\n    permission_classes = (IsAuthenticated,)\n\n    # file_class = File  # File handle class\n    # file_status = app_settings.status  # default: PENDING (Used when using background task, you can change it to COMPLETED.)\n    # optimize = True  # default: True\n    # remove_file_on_update = True  # Update image on admin page.\n    # chunk_size = 1024 * 1024 * 2  # Custom chunk size upload (default: 2MB).\n    # upload_to = \"custom_folder/%Y/%m/%d\"  # Custom upload folder.\n    # template_name = \"custom_template.html\"  # Custom template\n\n    # # Run background task like celery when upload is complete\n    # def background_task(self, instance):\n    #     pass\n```\n\ncustom_template.html\n```html\n\u003cform action=\".\"\n      method=\"post\"\n      id=\"chunk-upload-form\"\u003e\n    {{ form.media }}\n    {{ form }}\n\u003c/form\u003e\n```\n\nurls.py\n\n```pyhon\nfrom django.urls import path\n\nfrom .views import CustomChunkedUploadView\n\nurlpatterns = [\n    path(\"uploads/\", CustomChunkedUploadView.as_view(), name=\"custom-uploads\"),\n]\n```\n\n### Permissions\n```python\nfrom django_chunk_file_upload.permissions import AllowAny, IsAuthenticated, IsAdminUser, IsSuperUser\n```\n\n### File Handlers\n```python\nfrom django_chunk_file_upload.typed import (\n    ArchiveFile,\n    AudioFile,\n    BinaryFile,\n    DocumentFile,\n    File,\n    FontFile,\n    HyperTextFile,\n    ImageFile,\n    JSONFile,\n    MicrosoftExcelFile,\n    MicrosoftPowerPointFile,\n    MicrosoftWordFile,\n    SeparatedFile,\n    XMLFile,\n)\n```\n\n### Image Optimizer\nUse image Optimizer feature for other modules\n\n```python\nfrom django_chunk_file_upload.optimize import ImageOptimizer\nfrom django_chunk_file_upload.app_settings import app_settings\n\n# Image optimize method: resize, crop, delete, convert and optimize\n# This method calls two other methods:\n#   ImageOptimizer.resize: resize image\n#   ImageOptimizer.crop: example get parameters from Cropperjs (https://github.com/fengyuanchen/cropperjs).\nimage, path = ImageOptimizer.optimize(\n    fp='path/image.png',\n    filename=None,  # Rename the original file.\n    upload_to=None,  # Upload dir.\n    box=None,  # The crop rectangle, as a (left, upper, right, lower)-tuple to crop the image.\n    max_width =app_settings.image_optimizer.max_width,  # Max width of the image to resize.\n    max_height=app_settings.image_optimizer.max_height,  # Max height of the image to resize.\n    to_webp=True,  # Force convert image to webp type.\n    remove_origin =app_settings.image_optimizer.remove_origin,  # Force to delete original image after optimization.\n)\n```\n\n### UnitTests\n\n```shell\npython runtests.py\n```\n\nNote: This package is under development, only supports create view. There are also no features related to image optimization. Use at your own risk.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthewebscraping%2Fdjango-chunk-file-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthewebscraping%2Fdjango-chunk-file-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthewebscraping%2Fdjango-chunk-file-upload/lists"}