Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 3.84 KB

README.rst

File metadata and controls

129 lines (88 loc) · 3.84 KB

django-galleryfield

https://codecov.io/gh/dzhuang/django-galleryfield/branch/main/graph/badge.svg?token=W9BWM4A4RI https://github.com/dzhuang/django-galleryfield/actions/workflows/ci.yml/badge.svg?branch=main https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 Documentation Status

Django model fields GalleryField with AJAX form widgets and for multiple images upload with progress bar. This package is NOT about how to elegantly render multiple images in a page, but how to CRUD multiple images in a model field, which makes it possible for easy permission control.

Features

  • A model field GalleryField, and its formfield GalleryFormField along with the default widget GalleryWidget.
  • Drag & drop file uploading via AJAX
  • Uploading multiple images with progress bar
  • Drag & drop reordering, client / server side crop before/after upload.
  • Integrates with Django Admin.
  • Each Image uploaded will be saved in an image model. That might be considered, by some user, a draw back. However, that makes it possible to delete the orphan images from the server (see in FAQ).

ScreenShots

  • Multiple image upload, sortable

https://raw.githubusercontent.com/dzhuang/django-galleryfield/main/demo/static/demo/screen_upload.png

  • Client/Server side crop

https://raw.githubusercontent.com/dzhuang/django-galleryfield/main/demo/static/demo/screen_crop.png

  • Easy Gallery render

https://raw.githubusercontent.com/dzhuang/django-galleryfield/main/demo/static/demo/screen_detail.png

Quick Start

Requirements

Install

pip install django-galleryfield

Usage

  • In settings.py, add 3 lines in you INSTALLED_APP:
INSTALLED_APPS = (
    ...,
    'sorl.thumbnail',
    'galleryfield',
    ...,
)

DJANGO_GALLERY_CONFIG = ...
  • In urls.py, add the following lines:
from django.urls import include, path

urlpatterns += [path(r"gallery-handler/", include("galleryfield.urls"))]
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

Run the demo

git clone https://github.com/dzhuang/django-galleryfield.git
cd django-galleryfield
cd demo
pip install -r requirements.txt
cd ..
python manage.py migrate
python manage.py createsuperuser # Create a superuser account so that you can upload images
python manage.py runserver

Note

You might need to install JSON1 extension for SQLite for this the demo to run properly. See Enabling JSON1 extension on SQLite.

Online documentation

Please visit https://django-galleryfield.readthedocs.io for the documentation.

Contribute to the project

See Contribution guide.

License

Released under the MIT license.