OAREPO IIIF
This package adds support for input loaders for IIIF server
Rationale
We would like to add support for loading images from non-image source. For example, loading n-th image from a PDF file, converting data into graphs etc.
Invenio support for IIIF
Invenio has support for IIIF server via invenio-iiif package. Unfortunately there is no extensibility mechanism for loading images from non-image sources.
This package adds this support.
Usage
Opener functions
Create an opener and register it to entry point oarepo_iiif.openers . The uuid
contains an identification of the image. It is up to you to parse and interpret it.
def pdf_opener(uuid, app=None, **kwargs): # kwargs currently empty but keep them for extensibility
return binary stream of image data or None if can not handle the uuid
Check functions
If the opener loads data not from file buckets but from another location,
you have to register a function that checks access (and raises werkzeug exception
if the access is denied). The entry point for this function is oarepo_iiif.checks.
def pdf_check(uuid, app=None, **kwargs): # kwargs might contain 'version', 'region', 'size', 'rotation', 'quality', 'image_format'
"""
check permissions and return
* True if the access is ok
* None if can not handle
* raise an exception if access denied
"""
return True
See rest test for an example of these functions.
Indentifier creating functions (optional)
Optionally register an identifier creating function under entrypoint oarepo_iiif.identifier_makers.
The function gets invenio-record-files' FileObject and Record and should produce identifier
used in checks & openers.
def pdf_identifier(record: Record, file:FileObject, pid:PersistentIdentifier, app=None, **kwargs):
"""
return crafted PDF identifier
"""
return 'pdf-images:{recid}:{key}'.format(recid=record.id, key=file['key'])
Then power up the server and hit IIIF url:
curl https://127.0.0.1:5000/api/iiif/v2/<uuid>/<region>/<size>/<rotation>/<quality>.<format>
Integration with oarepo-records-draft
oarepo-records-draft adds support for uploading attachments with easier security checks than
those in invenio-files-rest or invenio-record-files.
Moreover, it provides a set of callbacks that are called whenever a file is associated to a record.
If oarepo-records-draft is detected, a custom handler is registered for attachment_uploaded_before_commit.
The handler
How it works (for library developers)
As extensibility mechanism is not available, this library overrides invneio-iiif uuid_to_image_opener
and api_decorator_callback in the app_loaded callback. Keep this in mind if you have libraries
that perform similar task.
@app_loaded.connect
def loaded(sender, app=None, **kwargs):
with app.app_context():
current_oarepo_iiif = app.extensions['oarepo-iiif']
iiif_ext = current_app.extensions['invenio-iiif'].iiif_ext
# replace opener
prev_opener = iiif_ext.uuid_to_image_opener
iiif_ext.uuid_to_image_opener_handler(
lambda *args, **akwargs: current_oarepo_iiif.open(*args, app=app, **akwargs) or prev_opener(*args, **akwargs)
)
# replace decorator handler
prev_decorator_handler = iiif_ext.api_decorator_callback
def decorator_handler(*args, **akwargs):
ret = current_oarepo_iiif.check(*args, app=app, **akwargs)
if ret is not None:
return ret
return prev_decorator_handler(*args, **akwargs)
iiif_ext.api_decorator_handler(decorator_handler)
Metadata
Release files for oarepo-iiif 1.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| oarepo-iiif-1.1.4.tar.gz | 6.4 kB | Without provenance | Details for oarepo-iiif-1.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| oarepo_iiif-1.1.4-py3-none-any.whl | Python 3 | none | any | Details for oarepo_iiif-1.1.4-py3-none-any.whl |
Total release size: 12.8 kB
Release files / oarepo-iiif-1.1.4.tar.gz
| Download URL | oarepo-iiif-1.1.4.tar.gz |
|---|---|
| Size | 6.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
610fcef40277d62369ee74396c33643e976d69b20e2241793d5e98ce08566fa1
|
|
BLAKE2b-256 checksum How to use checksums |
be8049e83d1c8ea933ec958883743dd5361ad08e17d45e643d9906fd84e5bfce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
|
Release files / oarepo_iiif-1.1.4-py3-none-any.whl
| Download URL | oarepo_iiif-1.1.4-py3-none-any.whl |
|---|---|
| Size | 6.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
70b175298facf92195b81ebebe4f3a25713e3d17a5edff2a3513c4928d9e86a3
|
|
BLAKE2b-256 checksum How to use checksums |
6eebeaaa623eaa0c982109cd28449dd82f9904d39b6779e1c8170829aad2f399
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
|
Security for oarepo-iiif 1.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.