Skip to main content

Python library for generating IIIF Image API urls

Project description

# piffle Python library for generating and parsing [IIIF Image API](http://iiif.io/api/image/2.1/) URLs in an object-oriented, pythonic fashion.

[![Build Status](https://travis-ci.org/emory-lits-labs/piffle.svg?branch=develop)](https://travis-ci.org/emory-lits-labs/piffle) [![Coverage Status](https://coveralls.io/repos/github/emory-lits-labs/piffle/badge.svg?branch=develop)](https://coveralls.io/github/emory-lits-labs/piffle?branch=develop) [![Code Health](https://landscape.io/github/emory-lits-labs/piffle/develop/landscape.svg?style=flat)](https://landscape.io/github/emory-lits-labs/piffle/develop)

## Installation and example use:

pip install piffle

Example use for generating an IIIF image url:

` >>> from piffle.iiif import IIIFImageClient >>> myimg = IIIFImageClient('http://image.server/path/', 'myimgid') >>> print myimg http://image.server/path/myimgid/full/full/0/default.jpg >>> print myimg.info() http://image.server/path/myimgid/info.json" >>> print myimg.size(width=120).format('png') http://image.server/path/myimgid/full/120,/0/default.png `

Example use for parsing an IIIF image url:

` >>> from piffle.iiif import IIIFImageClient >>> myimg = IIIFImageClient.init_from_url('http://www.example.org/image-service/abcd1234/full/full/0/default.jpg') >>> print myimg http://www.example.org/image-service/abcd1234/full/full/0/default.jpg >>> print myimg.info() http://www.example.org/image-service/abcd1234/info.json >>> myimg.as_dict()['size']['full'] True >>> myimg.as_dict()['size']['exact'] False >>> myimg.as_dict()['rotation']['degrees'] 0.0 `

## Development and Testing

This project uses [git-flow](https://github.com/nvie/gitflow) branching conventions.

Install locally for development (the use of virtualenv is recommended):

pip install -e .

Install test dependencies:

pip install -e “.[test]”

Run unit tests: py.test or python setup.py test

## Publishing

To upload a tagged release to [PyPI](https://pypi.python.org/pypi) with a [wheel](http://pythonwheels.com/) package:

python setup.py sdist bdist_wheel upload

Project details


Download files

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

Source Distribution

piffle-0.2.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

piffle-0.2.0-py2.py3-none-any.whl (8.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file piffle-0.2.0.tar.gz.

File metadata

  • Download URL: piffle-0.2.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for piffle-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e70ade2db04915c6e2e3404cad1210ebb9b4fd9e58ca21e6c72af21e2e3eb063
MD5 226547881ff8874be506b577a770f389
BLAKE2b-256 63c5e6ba9d34da1ace166c8b9104fb32773015064f0495ad7718eea0d4c36237

See more details on using hashes here.

File details

Details for the file piffle-0.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for piffle-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 61263b490eab3162d6d18723a56e5fe00543cc5388bd1ebeeb98cfdd900bf600
MD5 948217b0ba2e2d1c5b8487fd7a9dc432
BLAKE2b-256 d8fb4f8e3a0bf8ef7bf577c69930cabea9f474b2ed754e69bb0b77c36ae92583

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page