Skip to main content

IIIF Image API reference implementation

Project description

Build status Test coverage

iiif - IIIF Image API reference implementation and Python library. Supports the International Image Interoperability Framework: Image API 2.1 and 3.0 (as well as legacy versions 2.0, 1.1, 1.0). Also includes a test server using the library to implement the Image API transformations dynamically, and a static file generator to pre-compute tiles necessary for OpenSeadragon which may then be stored a static files.


The library, test server, static file generator are all designed to work with recent versions of Python 3 and Python 2.7. Manual installation is necessary to get the demonstration documentation and examples.

Automatic installation from PyPI

The iiif library code and scripts are available from PyPI and can be installed with pip, e.g.:

pip install iiif

The PyPI version does not include all demonstration documentation and examples.

Manual installation from github

First, clone the code and examples from the Github repository:

cd /tmp
git clone git://
cd iiif/

Second, install Pillow (a fork of PIL):

pip install Pillow

You may need sudo if installing system-wide as opposed to in a user-space environment.

After installation of Pillow there will be be a summary of image formats supported. Addition libraries may be require to get all formats depending on your platform.

The scripts and demonstrations can then be run from the iiif directory.

Finally, you may install the library code and scripts locally in the appropriate places within your python setup using:

python build
python install
  • You may need sudo to if installing system-wide as opposed to in a user-space environment

The source code is maintained on Github


Bug reports welcome as github issues.

See for guidelines for contributing, and the list of contributors

See also

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iiif-1.0.10.tar.gz (694.8 kB view hashes)

Uploaded source

Built Distribution

iiif-1.0.10-py3-none-any.whl (709.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page