Una volta che il tuo plugin è pronto e ritieni che esso possa essere utile per altre persone, non esitare a caricarlo su Repository di plugin python ufficiale. In questa pagina puoi trovare anche linee guida su come preparare il plugin per farlo funzionare bene con l’installatore di plugin. Oppure, nel caso in cui tu preferisca impostare un tuo repository di plugin personale, crea un semplice file XML che elencherà i plugin e i loro metadati, per esempi vedi altri repository di plugin.
Fai particolare attenzione ai seguenti suggerimenti:
evita di usare un nome molto simile a quello di plugin esistenti
se il tuo plugin offre funzionalità simili a quelle di un plugin esistente, evidenzia le differenze nel campo A proposito, così l’utente saprà quale dei due usare senza la necessità di installarlo e testarlo
evita di ripetere “plugin” nel nome del plugin stesso
usa il campo descrizione nei metadati per una descrizione di una riga, il campo A proposito per informazioni più dettagliate
includi un repository del codice, un bug tracker, e una pagina iniziale; ciò migliorerà notevolmente la possibilità di collaborazione, e può essere fatto molto facilmente con una delle infrastrutture web disponibili (GitHub, GitLab, Bitbucket, etc.)
scegli i tag con cura: evita quelli non esplicativi (ad es. vettore) e preferisci quelli già utilizzati da altri (vedi il sito web dei plugin)
aggiungi un’icona appropriata, non lasciare quella predefinita; visita l’interfaccia di QGIS per farti un’idea sullo stile da usare
non includere i file generati (ui_*.py, resources_rc.py, file di guida generati…) e materiale inutile (ad es. gitignore) nel repository
aggiungi il plugin al menu appropriato (Vettore, Raster, Web, Database)
quando necessario (plugin che eseguono analisi). considera la possibilità di aggiungere il plugin come sottoplugin dell’ambiente di Processing: ciò consentirà agli utenti di eseguirlo in serie, di integrarlo in flussi di lavoro più complessi ed eviterà l’onere di progettare un’interfaccia
includi almeno la documentazione minima e, se utili per il testing e la compresione, dati campione.
Puoi trovare il repositori di plugin python ufficiale su http://plugins.qgis.org/.
Per usare il repository ufficiale devi ottenere un ID OSGEO dal `portale web OSGEO<http://www.osgeo.org/osgeo_userid/>`_.
Una volta che avrai caricato il tuo plugin, esso sarà approvato da un membro del personale e ciò ti verrà notificato.
Inserisci un collegamento al documento di amministrazione
Queste regole sono state implementate nel repository di plugin ufficiale:
ogni utente registrato può aggiungere un nuovo plugin
gli utenti facenti parte del personale possono approvare o rifiutare tutte le versioni del plugin
gli utenti che hanno il privilegio speciale plugins.can_approve ricevono l’approvazione automatica delle versioni da loro caricate
gli utenti che hanno il privilegio speciale plugins.can_approve possono approvare versioni caricate da altri finché si trovano nella lista dei proprietari del plugin
uno specifico plugin può essere cancellato e modificato soltanto dai membri del personale e dai proprietari del plugin
se un utente senza il privilegio plugins.can_approve carica una nuova versione, la versione del plugin è automaticamente rifiutata.
I membri del personale possono accordare l’affidabilità ai creatori del plugin selezionato impostando il privilegio plugins.can_approve attraverso l’applicazione front-end.
La vista dei dettagli del plugin offre collegamenti diretti per accordare l’affidabilità al creatore del plugin o ai proprietari del plugin.
I metadati del plugin sono importati automaticamente e validati dal pacchetto compresso quando il plugin è caricato.
Ecco alcune regole di validazione che dovresti conoscere quando desideri caricare un plugin nel repository ufficiale:
il nome della cartella principale contenente il tuo plugin deve contenere solo caratteri ASCII (A-Z e a-z), numeri e i caratteri trattino basso (_) e meno (-), inoltre non può iniziare con un numero
È richiesto il file metadata.txt
tutti i metadati richiesti elencati nella tabella metadati devono essere presenti
il campo metadati version deve essere unico
Seguendo le regole di convalida, il pacchetto compresso (.zip) del tuo plugin deve avere una struttura specifica per validarsi come un plugin efficiente. Siccome il plugin sarà scompattato all’interno della cartella dei plugin dell’utente, esso deve avere la sua cartella propria dentro il file .zip per non interferire con gli altri plugin. I file obbligatori sono: metadata.txt e __init__.py. Ma sarebbe apprezzato avere un file LEGGIMI e certamente un’icona per rappresentare il plugin (resources.qrc). Di seguito un esempio di come un file plugin.zip dovrebbe apparire.
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