16.5. Lanzamiento de su complemento

Una vez que su complemento esté listo y crea que el complemento podría ser útil para algunas personas, no dude en cargarlo en Repositorio oficial de complementos de Python. En esa página también puede encontrar pautas de empaquetado sobre cómo preparar el complemento para que funcione bien con el instalador del complemento. O en caso de que desee configurar su propio repositorio de complementos, cree un archivo XML simple que enumere los complementos y sus metadatos.

Preste especial atención a las siguientes sugerencias:

16.5.1. Metadatos y nombres

  • evite usar un nombre demasiado similar a los complementos existentes

  • Si su complemento tiene una funcionalidad similar a un complemento existente, explique las diferencias en el campo Acerca de, para que el usuario sepa cuál usar sin la necesidad de instalarlo y probarlo.

  • evitar repetir «complemento» en el nombre del propio complemento

  • use el campo de descripción en los metadatos para una descripción de 1 línea, el campo Acerca de para obtener instrucciones más detalladas

  • incluir un depósito de código, un rastreador de errores y una página de inicio; esto mejorará enormemente la posibilidad de colaboración y se puede hacer muy fácilmente con una de las infraestructuras web disponibles (GitHub, GitLab, Bitbucket, etc.)

  • elija las etiquetas con cuidado: evite las que no son informativas (por ejemplo, vector) y prefiera las que ya utilizan otros (consulte el sitio web del complemento)

  • agregue un icono adecuado, no deje el predeterminado; consulte la interfaz de QGIS para obtener una sugerencia del estilo que se utilizará

16.5.2. Código y ayuda

  • no incluya el archivo generado (ui_*.py, resources_rc.py, archivos de ayuda generados …) y cosas inútiles (por ejemplo, .gitignore) en el repositorio

  • agregue el complemento al menú apropiado (Vector, Raster, Web, Database)

  • cuando sea apropiado (complementos que realizan análisis), considere agregar el complemento como un subplugin del marco de procesamiento: esto permitirá a los usuarios ejecutarlo en lotes, integrarlo en flujos de trabajo más complejos y lo liberará de la carga de diseñar una interfaz

  • incluya al menos documentación mínima y, si es útil para probar y comprender, datos de muestra.

16.5.3. Repositorio oficial de complementos de Python

Puede encontrar el repositorio de complementos de Python oficial en https://plugins.qgis.org/.

Para utilizar el repositorio oficial, debe obtener un ID de OSGEO en el portal web OSGEO.

Una vez que haya cargado su complemento, un miembro del personal lo aprobará y se le notificará.

PENDIENTE:

Insertar un enlace al documento de gobernanza

16.5.3.1. Permisos

Estas reglas se han implementado en el repositorio oficial de complementos:

  • cada usuario registrado puede agregar un nuevo complemento

  • staff los usuarios pueden aprobar o rechazar todas las versiones del complemento

  • los usuarios que tienen el permiso especial plugins.can_approve obtienen las versiones que cargan automáticamente aprobadas

  • los usuarios que tienen el permiso especial plugins.can_approve pueden aprobar versiones cargadas por otros siempre que estén en la lista de plugins propietarios

  • un complemento en particular puede ser eliminado y editado solo por personal usuarios y propietarios de complementos

  • si un usuario sin el permiso plugins.can_approve carga una nueva versión, la versión del complemento no se aprueba automáticamente.

16.5.3.2. Gestión de confianza

Los miembros del personal pueden otorgar confianza a los creadores de complementos seleccionados que configuran el permiso plugins.can_approve a través de la aplicación frontal.

La vista de detalles del complemento ofrece enlaces directos para otorgar confianza al creador del complemento o los propietarios del complemento.

16.5.3.3. Validación

Los metadatos del complemento se importan y validan automáticamente desde el paquete comprimido cuando se carga el complemento.

Aquí hay algunas reglas de validación que debe conocer cuando desee cargar un complemento en el repositorio oficial:

  1. el nombre de la carpeta principal que contiene su complemento debe contener solo caracteres ASCII (A-Z y a-z), dígitos y los caracteres de subrayado (_) y menos (-), además no puede comenzar con un dígito

  2. metadata.txt es requerido

  3. todos los metadatos requeridos enumerados en tabla de metadatos deben estar presentes

  4. el campo de metadatos versión debe ser único

16.5.3.4. Estructura de complementos

Siguiendo las reglas de validación, el paquete comprimido (.zip) de su complemento debe tener una estructura específica para validarlo como un complemento funcional. Como el complemento se descomprimirá dentro de la carpeta de complementos de los usuarios, debe tener su propio directorio dentro del archivo .zip para no interferir con otros complementos. Los archivos obligatorios son: metadata.txt y __init __.Py. Pero sería bueno tener un: file: README y, por supuesto, un ícono para representar el complemento (resources.qrc). A continuación se muestra un ejemplo de cómo debería verse un plugin.zip.

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