Package Health Score

53 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

nir
72

Popularity

Limited

GitHub Stars: 490
Forks: 184
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package niiif-niiif, we found that it has been starred 490 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Dec 15, 2021
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like niiif-niiif is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 152
Open PR: 40
Last Release: 3 years ago
Last Commit: 2 months ago

Further analysis of the maintenance status of niiif-niiif based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for niiif-niiif is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 40
Funding: Yes

With more than 10 contributors for the niiif-niiif repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.6

Age: 3 years
Latest Release: 3 years ago
Dependencies: 2 Direct / 6 Total
Versions: 6
Maintainers: 1
Wheels: OS Independent

Readme

La librairie niiif-niiif crée et publie le manifeste IIIF des fichiers JPEG et TIFF d'une donnée Nakala.

Nakala est un service de la TGIR (Très Grande Infrastructure de Recherche) Huma-Num permettant à des chercheurs, enseignants-chercheurs et équipes de recherche de partager, publier et valoriser tous types de données numériques documentées (fichiers textes, sons, images, vidéos, objets 3D, etc.) dans un entrepôt sécurisé afin de les publier en accord avec les principes du FAIR data (Facile à trouver, Accessible, Interopérable et Réutilisable).

Les images déposées sur Nakala sont accessibles à travers une API compatible avec IIIF Image API 3.0 mais Huma-Num ne propose pas de service de création de manifestes, ces fichiers JSON qui permettent la lecture des images par des visionneuses compatibles avec le protocole IIIF.

La librarie Python niiif-niiif propose donc de palier temporairement à ce manque.

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 IIIF Cantaloupe utilisé par Nakala n'étant compatible qu'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')

niiif-niiif dependencies

requests tqdm

FAQs

What is niiif-niiif?

Création et dépôt de manifestes IIIF pour des données déposées sur Nakala. Visit Snyk Advisor to see a full health score report for niiif-niiif, including popularity, security, maintenance & community analysis.

Is niiif-niiif popular?

The python package niiif-niiif receives a total of 66 weekly downloads. As such, niiif-niiif popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is niiif-niiif well maintained?

We found indications that niiif-niiif is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is niiif-niiif safe to use?

While scanning the latest version of niiif-niiif, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 7 October-2024, at 04:20 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

niiif-niiif

Création et dépôt de manifestes IIIF pour des données déposées sur Nakala For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Non-Permissive License

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Installation

Utilisation

En ligne de commande

Dans un script Python

niiif-niiif dependencies

FAQs

What is niiif-niiif?

Is niiif-niiif popular?

Is niiif-niiif well maintained?

Is niiif-niiif safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Installation

Utilisation

En ligne de commande

Dans un script Python

niiif-niiif dependencies

FAQs

What is niiif-niiif?

Is niiif-niiif popular?

Is niiif-niiif well maintained?

Is niiif-niiif safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues