Quick Start


You can install with pip from PyPi via:

pip install django-galleryfield

Or for the latest dev version, via:

pip install git+https://github.com/dzhuang/django-galleryfield.git

Python version

Gallery-widget is compatible with Python 3 (3.6 or later were tested).


Python dependencies:

  • Django 3.1 or later

  • sorl-thumbnail (auto installed)

  • pillow (auto installed)

  • django-npm (optional, for managing statics, you need to have npm installed in your OS)

Static dependencies:

The static dependencies can be installed by command npm install.


  • In settings.py, add 3 lines in you INSTALLED_APP:


  • We strongly propose using django-npm to manage the static dependencies, by adding the following lines in settings.py:

from django.conf.global_settings import STATICFILES_FINDERS

STATICFILES_FINDERS = tuple(STATICFILES_FINDERS) + ("npm.finders.NpmFinder",)
  • In urls.py, add the following lines:

from django.urls import include, path

urlpatterns += [path(r"images-handler/", include("galleryfield.urls"))]
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
  • Sync the database:

    python manage.py migrate galleryfield

Run the demo

The best way to have a glance of how django-galleryfield works is to run the demo:

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


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