Installation¶

Requirements¶

Python 3.10+
Django (installed automatically as a dependency)
A running IIIF Image API server to serve the actual image pixels (djiiif builds URLs and documents that point at it; see djiiif).

$ pip install djiiif

Extra	Install	Adds
Django REST Framework	`pip install "djiiif[drf]"`	The serializer field
Documentation toolchain	`pip install "djiiif[docs]"`	Sphinx + theme for building these docs
Full dev toolchain	`pip install -e ".[dev]"`	Tests, build, docs (for contributors)

The core package never imports DRF, so installing without the drf extra keeps your dependency tree minimal.

Add it to INSTALLED_APPS — this enables the system check that validates your configuration, and is required to use the template tags:

settings.py¶

INSTALLED_APPS = [
    # ...
    "djiiif",
]

To use the optional drop-in views, include the URLconf:

urls.py¶

from django.urls import include, path

urlpatterns = [
    path("iiif/", include("djiiif.urls")),
]

Continue with the Quickstart.