Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Princeton-CDH/piffle
python library for generating and parsing IIIF Image API URLs
https://github.com/Princeton-CDH/piffle
iiif-image python python-library python27 python3
Last synced: about 2 months ago
JSON representation
python library for generating and parsing IIIF Image API URLs
- Host: GitHub
- URL: https://github.com/Princeton-CDH/piffle
- Owner: Princeton-CDH
- License: apache-2.0
- Created: 2016-07-27T19:01:39.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T20:38:10.000Z (5 months ago)
- Last Synced: 2024-10-13T22:04:24.439Z (3 months ago)
- Topics: iiif-image, python, python-library, python27, python3
- Language: Python
- Homepage:
- Size: 139 KB
- Stars: 17
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-iiif - piffle - Python library for generating and parsing IIIF Image API URLs. (Image API Libraries / Image viewers (Image API only))
README
# piffle
Python library for generating and parsing [IIIF Image API](http://iiif.io/api/image/2.1/) URLs in an
object-oriented, pythonic fashion.
[](https://github.com/Princeton-CDH/piffle/actions/workflows/unit_tests.yml)
[](https://codecov.io/gh/Princeton-CDH/piffle)
[](https://codeclimate.com/github/Princeton-CDH/piffle/maintainability)
Piffle is tested on Python 3.8—3.12.
Piffle was originally developed by Rebecca Sutton Koeser at Emory University as a part of [Readux](https://github.com/ecds/readux) and forked as a separate project under [emory-lits-labs](https://github.com/emory-lits-labs/). It was later transferred to Rebecca Sutton Koeser at the Center for Digital Humanities at Princeton.
## Installation and example use:
`pip install piffle`
Example use for generating an IIIF image url:
```
>>> from piffle.image 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.image 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
```
Example use for reading a IIIF manifest:
```
>>> from piffle.image import IIIFImageClient
>>> from piffle.presentation import IIIFPresentation
>>> manifest = IIIFPresentation.from_url('https://iiif.bodleian.ox.ac.uk/iiif/manifest/60834383-7146-41ab-bfe1-48ee97bc04be.json')
>>> manifest.label
'Bodleian Library MS. Bodl. 264'
>>> manifest.id
'https://iiif.bodleian.ox.ac.uk/iiif/manifest/60834383-7146-41ab-bfe1-48ee97bc04be.json'
>>> manifest.type
'sc:Manifest'
>>> for canvas in manifest.sequences[0].canvases[:5]:
... image_id = canvas.images[0].resource.id
... iiif_img = IIIFImageClient(*image_id.rsplit('/', 1))
... print(str(iiif_img.size(height=250)))
...
https://iiif.bodleian.ox.ac.uk/iiif/image/90701d49-5e0c-4fb5-9c7d-45af96565468/full/,250/0/default.jpg
https://iiif.bodleian.ox.ac.uk/iiif/image/e878cc78-acd3-43ca-ba6e-90a392f15891/full/,250/0/default.jpg
https://iiif.bodleian.ox.ac.uk/iiif/image/0f1ed064-a972-4215-b884-d8d658acefc5/full/,250/0/default.jpg
https://iiif.bodleian.ox.ac.uk/iiif/image/6fe52b9a-5bb7-4b5b-bbcd-ad0489fcad2a/full/,250/0/default.jpg
https://iiif.bodleian.ox.ac.uk/iiif/image/483ff8ec-347d-4070-8442-dbc15bc7b4de/full/,250/0/default.jpg
```
## Development and Testing
This project uses [git-flow](https://github.com/nvie/gitflow) branching conventions.
Install locally for development (the use of a python virtualenv is recommended):
`pip install -e .`
Install test dependencies:
`pip install -e ".[dev]"`
Run unit tests: `py.test` or `python setup.py test`
### Install pre-commit hooks
Anyone who wants to contribute to this codebase should install the configured pre-commit hooks:
```
pre-commit install
```
This will configure a pre-commit hooks to automatically lint and format python code with [ruff](https://github.com/astral-sh/ruff) and [black](https://github.com/psf/black).
Pre-commit hooks and formatting conventions were added at version 0.5, so ``git blame`` may not reflect the true author of a given change. To make ``git blame`` more accurate, ignore formatting revisions:
```
git blame --ignore-revs-file .git-blame-ignore-revs
```
Or configure your git to always ignore styling revision commits:
```
git config blame.ignoreRevsFile .git-blame-ignore-revs
```
## Publishing python packages
A new python package is automatically built and published to [PyPI](https://pypi.python.org/pypi) using a GitHub Actions workflow when a new release is created on GitHub.