====
iiif
====

.. image:: https://travis-ci.org/zimeon/iiif.png
  :target: https://travis-ci.org/zimeon/iiif
  :alt: Build status

.. image:: https://coveralls.io/repos/zimeon/iiif/badge.png
  :target: https://coveralls.io/r/zimeon/iiif
  :alt: Test coverage

*iiif* - A Python library implementing the 
`International Image Interoperability Framework: Image API 2.0
<http://iiif.io/api/image/2.0/>`_ and 
Image API 1.1
`<http://iiif.io/api/image/1.1/>`_.
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.

Installation
------------

The library, test server, static file generator are all designed to
work with Python 2.6 or 2.7.

**Automatic installation**::

    easy_install iiif

*iiif* is listed in `PyPI
<http://pypi.python.org/pypi/iiif>`_ and can be installed with 
``pip`` or ``easy_install``. 

**Manual installation from github**::

First install `Pillow` (a fork of `PIL`)

    sudo pip install Pillow

and then clone and install from this repository

    cd /tmp
    git clone git://github.com/zimeon/iiif.git
    cd iiif/
    python setup.py build
    sudo python setup.py install

This will install the library code in the appropriate place within 
your python setup.

The source code is maintained on `Github
<https://github.com/zimeon/iiif>`_

See also
--------

  * http://github.com/zimeon/iiif -- git repository
  * https://github.com/zimeon/iiif/tree/master/demo -- Static File Demo with OpenSeadragon 

Copyright and License
---------------------

    iiif library and programs implementing the IIIF API
    Copyright (C) 2012,2013,2014 Simeon Warner

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
   
See `LICENSE.txt
<LICENSE.txt>`_
