Une fois que l’extension est prête et que vous pensez qu’elle pourra être utile à d’autres, n’hésitez pas à la téléverser sur Dépôt officiel des extensions Python. Sur cette page, vous pouvez également trouver un guide d’empaquetage sur comment préparer l’extension pour qu’elle fonctionne correctement avec l’installateur d’extensions. Dans le cas où vous souhaitez mettre en place votre propre dépôt d’extensions, créez un unique fichier XML qui listera vos extensions ainsi que leur métadonnées Pour des exemples, consultez les autres dépôts d’extension.
Vous pouvez trouver le dépôt officiel des extensions python à http://plugins.qgis.org/.
Afin d’utiliser le dépôt officiel, vous devez détenir un identifiant OSGEO, à partir du portail web OSGEO.
Une fois que vous avez téléversé votre extension, elle sera approuvée par un membre du staff et une notification vous sera adressée.
Insérer un lien vers le document de gouvernance
Ces règles ont été implémentées dans le dépôt officiel des extensions :
tout utilisateur enregistré peut ajouter une nouvelle extension
les utilisateurs membres du staff sont habilités à approuver ou non chacune des versions de toutes les extensions
Les utilisateurs qui ont l’autorisation spéciale plugins.can_approve ont leurs versions d’extension automatiquement approuvées
Les utilisateurs ayant l’autorisation spéciale plugins.can_approve peuvent approuver les versions téléversées par d’autres, dès lors qu’ils sont dans la liste des propriétaires de l’extension
une extension particulière peut être effacée et éditer uniquement par les utilisateurs de l’équipe et par leurs propriétaires
Si un utilisateur ne disposant pas de la permission plugins.can_approve téléverse une nouvelle version, cette version de l’extension est automatiquement signalée comme non approuvée.
Les membres de l’équipe peuvent ajouter un niveau de confiance à certains créateurs d’extension en paramétrant la permission dans la variable plugins.can_approve depuis l’application frontale.
La vue détaillée de l’extension montre les liens directs pour modifier le niveau de confiance du créateur d’extension ou des propriétaires de l’extension.
Les métadonnées de l’extension sont importées et validées automatiquement à partir du paquet compressé lorsque l’extension est envoyée.
Voici quelques règles de validation auxquelles vous devriez faire attention quand vous souhaitez charger votre extension sur le dépôt officiel:
le nom du dossier principal contenant votre extension ne doit contenir que des caractères ASCII (A-Z et a-z), des chiffres et les caractères underscore(_) et moins (-), sans cependant commencer par un chiffre
metadata.txt
est requis
Toutes les métadonnées requises listées dans metadata table doivent être présentes.
Le champ de métadonnée version doit être unique
Le paquet compressé (.zip) de votre extension, suivant les règles de validation, doit avoir une structure spécifique pour être validé en tant qu’extension fonctionnelle. Étant donné que l’extension doit être décompressée à l’intérieur du répertoire des extensions de l’utilisateur, elle doit disposer de sont propre répertoire au sein de l’archive .zip pour ne pas interférer avec les autres extensions. Les fichiers obligatoires sont: metadata.txt
et __init__.py
. Il serait également appréciable de fournir un fichier README
ainsi qu’une icône pour représenter l’extension (resources.qrc
). Voici à quoi devrait ressembler le contenu d’une archive zip contenant une extension:
plugin.zip
pluginfolder/
|-- i18n
| |-- translation_file_de.ts
|-- img
| |-- icon.png
| `-- iconsource.svg
|-- __init__.py
|-- Makefile
|-- metadata.txt
|-- more_code.py
|-- main_code.py
|-- README
|-- resources.qrc
|-- resources_rc.py
`-- ui_Qt_user_interface_file.ui