Invenio-IIIF

https://img.shields.io/github/license/inveniosoftware/invenio-iiif.svg https://img.shields.io/travis/inveniosoftware/invenio-iiif.svg https://img.shields.io/coveralls/inveniosoftware/invenio-iiif.svg https://img.shields.io/pypi/v/invenio-iiif.svg

IIIF Image API implementation for Invenio

Features:

  • Thumbnail generation and previewing of images.
  • Allows to preview, resize and zoom images, by implementing the IIIF API.
  • Provide celery task to create image thumbnails.

Further documentation available: https://invenio-iiif.readthedocs.io/

User’s Guide

This part of the documentation will show you how to get started in using Invenio-IIIF.

Installation

Invenio-IIIF is on PyPI so all you need is:

$ pip install invenio-iiif

Invenio-IIIF uses Pillow for image processing.

To create cover images from PDFs, you need to install locally the ImageMagick image library. See https://imagemagick.org for details.

Configuration

Invenio-IIIF depends heavily on Flask-IIIF module for images transformation. Configurations related to images formats, resize and caching are provided by Flask-IIIF:

  • IIIF_RESIZE_RESAMPLE
    Specifies the algorithm used to resample the image. The default one is PIL.image.BICUBIC
  • IIIF_CACHE_HANDLER
    Specifices how to cache thumbnails, e.g. in memory, Redis or any custom implementation.
  • IIIF_CACHE_TIME
    Specifies for how long images will be cached.
  • IIIF_FORMATS
    Specifies the supported images formats and associated MIME types

Usage

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

API Docs

Handlers

Previewer

Tasks

Utils

Additional Notes

Notes on how to contribute, legal information and changes are here for the interested.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

Report bugs at https://github.com/inveniosoftware/invenio-iiif/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.
Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

Invenio-IIIF could always use more documentation, whether as part of the official Invenio-IIIF docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/inveniosoftware/invenio-iiif/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up invenio-iiif for local development.

  1. Fork the inveniosoftware/invenio-iiif repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/invenio-iiif.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv invenio-iiif
$ cd invenio-iiif/
$ pip install -e .[all]

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass tests:

    $ ./run-tests.sh

    The tests will provide you with test coverage and also check PEP8 (code style), PEP257 (documentation), flake8 as well as build the Sphinx documentation and run doctests.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -s
    -m "component: title without verbs"
    -m "* NEW Adds your new feature."
    -m "* FIX Fixes an existing issue."
    -m "* BETTER Improves and existing feature."
    -m "* Changes something that should not be visible in release notes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests and must not decrease test coverage.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.
  3. The pull request should work for Python 2.7, 3.5 and 3.6. Check https://travis-ci.org/inveniosoftware/invenio-iiif/pull_requests and make sure that the tests pass for all supported Python versions.

Changes

Version 1.1.0 (released 2020-03-19)

  • Remove Python 2.7 support.
  • Bump Flask-IIIF to v0.6.

Version 1.0.0 (released 2019-07-24)

  • Initial public release.

License

MIT License

Copyright (C) 2018-2019 CERN.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Note

In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.

Authors

  • Chiara Bigarella
  • Esteban J. G. Gabancho
  • Harris Tzovanakis
  • Lars Holm Nielsen
  • Nikos Filippakis
  • Sebastian Witowski