Création et dépôt de manifestes IIIF pour des données déposées sur Nakala
Project description
La librairie niiif-niiif crée et publie le manifeste IIIF d'une donnée Nakala.
Plus précisément, niiif-niiif :
- Vérifie si la donnée Nakala dont l'identifiant lui est donné en paramètre existe. Le cas échéant,
- Supprime s'il existe l'ancien fichier metadata.json des fichiers de la donnée,
- Crée un manifeste IIIF à partir des fichiers JPEG ou TIFF de la donnée Nakala,
- Ajoute à la donnée Nakala le fichier metadata.json contenant le manifeste.
Vous pouvez ensuite copier l'URL de téléchargement du fichier metadata.json et la transmettre à une visionneuse IIIF (ex. Mirador).
L'URL d'un fichier déposé sur Nakala est unique. L'URL du manifeste d'une donnée changera donc à chaque fois que vous le créerez avec niiif-niiif. Pensez à soumettre cette nouvelle URL à la visionneuse.
Le serveur d'image Cantaloupe de Nakala n'étant compatible que avec IIIF Image API 3.0, niiif-niiif génère depuis sa version 0.2.0 des manifestes conformes à IIIF Presentation API 3.0.
Depuis la version 0.2.0, il est possible de préciser en paramètre si le document doit-être affiché de manière paginée (voir la propriété behavior de IIIF Presentation API 3.0).
Les manifestes de niiif-niiif ont été testés avec les visionneuses IIIF suivantes :
- UniversalViewer v3.0 : Il y a un bug d'affichage des vignettes de manifestes API Presentation 3.0 avec UV 3.x.
- UniversalViewer v4.0 : Il y a un bug d'affichage des vignettes de manifestes API Presentation 3.0 avec UV 4.x.
- TIFY : Problème d'affichage
- Mirador : OK
Installation
Pour utiliser le script, utilisez de préférence un gestionnaire d'environnement Python tel que Miniconda.
# Vous pouvez définir le nom de l'environnement Python à votre convenance avec le paramètre -n.
conda create -n niiif-niiif python=3.8
# Activez l'environnement
conda activate niiif-niiif
# Installez la librairie niiif
pip install niiif-niiif
Utilisation
Le script a besoin pour fonctionner des clés d'API d'un compte utilisateur Nakala ayant des droits d'écriture sur la donnée Nakala pour laquelle vous souhaitez créer un manifeste. Cette clé d'API est à créer et à copier depuis le profil du compte Nakala.
En ligne de commande
# Activez l'environnement (si ce n'est pas déjà fait)
conda activate niiif-niiif
# Pour afficher les arguments du script
python -m niiif -h
# Pour créer le manifeste de la donnée Nakala dont l'ID = 10.34847/nkl.12121212 avec un affichage paginé dans la visioneuse IIIF de votre choix (le paramètre -behavior est optionnel)
python -m niiif -apikey 12345678-12345678-1234578-12345678 -dataid 10.34847/nkl.12121212 -behavior paged
Dans un script Python
La fonction create_data_manifest_if_data_exists(apiKey, dataIdentifier)
peut être importée depuis un script Python.
# Activez l'environnement (si ce n'est pas déjà fait)
conda activate niiif-niiif
# Lancez python
python
>>> from niiif import create_data_manifest_if_data_exists
>>> create_data_manifest_if_data_exists(apiKey='12345678-12345678-1234578-12345678', dataIdentifier='10.34847/nkl.12121212')
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for niiif_niiif-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55b808caf0a7469120cb9021b6920cd7bdd15f6de6a8680c6ccbe10e702c44fd |
|
MD5 | 7281a111f605704a4dcb2ca8f9cb72d6 |
|
BLAKE2b-256 | d72805ee887c1d8825b02048837461204099bb9a28dad003dcea637aaa8f1b49 |