Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giacomomarchioro/pyIIIFpres
Python module for easing the construction of JSON manifests compliant with IIIF API 3.0.
https://github.com/giacomomarchioro/pyIIIFpres
api3 iiif iiif-presentation python3
Last synced: about 2 months ago
JSON representation
Python module for easing the construction of JSON manifests compliant with IIIF API 3.0.
- Host: GitHub
- URL: https://github.com/giacomomarchioro/pyIIIFpres
- Owner: giacomomarchioro
- License: mit
- Created: 2021-01-27T07:38:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T12:04:33.000Z (5 months ago)
- Last Synced: 2024-10-02T17:36:12.668Z (3 months ago)
- Topics: api3, iiif, iiif-presentation, python3
- Language: Python
- Homepage:
- Size: 1.24 MB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-iiif - pyIIIFpres - A Python module built for easing the construction of JSON manifests compliant with IIIF API 3.0 in a production environment, similarly to iiif-prezi for earlier versions of the protocol. (Presentation API Libraries / Image viewers (Image API only))
README
# pyIIIFpres
[](https://travis-ci.com/giacomomarchioro/pyIIIFpres) [](https://coveralls.io/github/giacomomarchioro/pyIIIFpres?branch=main)[](https://pyiiifpres.readthedocs.io/en/latest/?badge=latest)
----------------
This is a Python module built for easing the construction of JSON manifests compliant with IIIF [API 3.0](https://iiif.io/api/presentation/3.0/) in a production environment, similarly to [iiif-prezi](https://github.com/iiif-prezi/iiif-prezi) for earlier versions of the protocol.
## Installation
The library uses only standard libraries and can be installed using `pip`.
Stable version:
pip install pyIIIFpres
Development :
pip install git+https://github.com/giacomomarchioro/pyIIIFpres
## Basic usage
The module maps the API structure to Python classes. The user `set_` objects that can have only one value (e.g. `id`) and `add_` objects that can have multiple entities (e.g. `labels`).
As an example, we will execute the [Simple Manifest - Book recipe](https://iiif.io/api/cookbook/recipe/0009-book-1/) from the IIIF cookbook. More examples from the [cookbook](https://iiif.io/api/cookbook/) are in the examples folder of this repository.
```python
from IIIFpres import iiifpapi3
iiifpapi3.BASE_URL = "https://iiif.io/api/cookbook/recipe/0009-book-1/"
manifest = iiifpapi3.Manifest()
manifest.set_id(extendbase_url="manifest.json")
manifest.add_label("en","Simple Manifest - Book")
manifest.add_behavior("paged")
# label width height id service
data = (("Blank page",3204,4613,"https://iiif.io/api/image/3.0/example/reference/59d09e6773341f28ea166e9f3c1e674f-gallica_ark_12148_bpt6k1526005v_f18","/full/max/0/default.jpg"),
("Frontispiece",3186,4612,"https://iiif.io/api/image/3.0/example/reference/59d09e6773341f28ea166e9f3c1e674f-gallica_ark_12148_bpt6k1526005v_f19","/full/max/0/default.jpg"),
("Title page",3204,4613,"https://iiif.io/api/image/3.0/example/reference/59d09e6773341f28ea166e9f3c1e674f-gallica_ark_12148_bpt6k1526005v_f20","/full/max/0/default.jpg"),
("Blank page",3174,4578,"https://iiif.io/api/image/3.0/example/reference/59d09e6773341f28ea166e9f3c1e674f-gallica_ark_12148_bpt6k1526005v_f21","/full/max/0/default.jpg"),
("Bookplate",3198,4632,"https://iiif.io/api/image/3.0/example/reference/59d09e6773341f28ea166e9f3c1e674f-gallica_ark_12148_bpt6k1526005v_f22","/full/max/0/default.jpg"),)
for idx,d in enumerate(data):
idx+=1
canvas = manifest.add_canvas_to_items()
canvas.set_id(extendbase_url="canvas/p%s"%idx) # in this case we use the base url
canvas.set_height(d[2])
canvas.set_width(d[1])
canvas.add_label("en",d[0])
annopage = canvas.add_annotationpage_to_items()
annopage.set_id(extendbase_url="page/p%s/1" %idx)
annotation = annopage.add_annotation_to_items(target=canvas.id)
annotation.set_id(extendbase_url="annotation/p%s-image"%str(idx).zfill(4))
annotation.set_motivation("painting")
annotation.body.set_id("".join(d[3:]))
annotation.body.set_type("Image")
annotation.body.set_format("image/jpeg")
annotation.body.set_width(d[1])
annotation.body.set_height(d[2])
s = annotation.body.add_service()
s.set_id(d[3])
s.set_type("ImageService3")
s.set_profile("level1")
manifest.json_save("manifest.json")
```
## Debug the manifest
When you are populating a new IIIF type from scratch some helpful functions can be
used for spotting errors.
`.inspect()` method returns a JSON representation of the object where the
recommended and required fields are shown:
```python
from IIIFpres import iiifpapi3
manifest = iiifpapi3.Manifest()
manifest.inspect()
```
`.show_errors_in_browser()` method opens a new browser tab highlighting the
required and recommended fields.
```python
manifest.show_errors_in_browser()
```
## Reading the manifest (experimental)
A JSON file compliant with presentation API3 can be read as follows:
```python
from IIIFpres.utilities import read_API3_json
mymanifest = read_API3_json('manifest.json')
```
This map Canvas, Annotation and the major IIIF types to iiifpapi3 classes, loading the rests as dicts.
See the [project wiki](https://github.com/giacomomarchioro/pyIIIFpres/wiki) or read the complete documentation on [readthedocs.io](https://pyiiifpres.readthedocs.io/) for information regarding [getting image sizes automatically](https://github.com/giacomomarchioro/pyIIIFpres/wiki/Getting-image-sizes-automatically), [improve the writing performance](https://github.com/giacomomarchioro/pyIIIFpres/wiki/Improve-performance-of-writing-and-serving-JSON-IIIF-objects) and more.
## Acknowledgements
The package is provided by the [Laboratorio di Studi Medievali e Danteschi](https://sites.hss.univr.it/laboratori_integrati/laboratorio-lamedan/) of the [University of Verona](https://www.univr.it/en/home)
Besides contributors, I would like to thank [dnoneill](https://github.com/dnoneill) for suggestions, and IIIF community and coordinators.