Liberando seu complemento

Uma vez que o seu complemento estiver pronto e você achar que o complemento pode ser útil para algumas pessoas, não hesite em enviá-lo para Repositório oficial de complementos python. Nessa página você pode encontrar também pacotes de orientações sobre como preparar o complemento para funcionar bem com o instalador de complementos. Ou no caso de você gostaria de criar o seu próprio repositório de complementos, criando um arquivo XML simples que irá listar os complementos e seus metadados, para exemplos, ver outros repositórios de complementos.

Repositório oficial de complementos python

Você pode encontrar o repositório oficial de complementos python emt http://plugins.qgis.org/.

Para usar o repositório oficial, deve obter uma ID OSGEO do portal web OSGEO.

Depois de carregado o seu complemento será aprovado por um membro da equipe e você será notificado.

TODO:

Insira um link para o documento de governança.

Permissões

Estas regras foram implementadas no repositório oficial de complementos:

  • todos os usuários registrados podem adicionar um novo plugin

  • A equipe de usuários podem aprovar ou reprovar todas as versões do plugin

  • Os usuários que têm permissão especial plugins.can_approve automaticamente têm suas versões de extensão aprovado

  • usuários que têm a permissão especial plugins.can_approve pode aprovar versões carregadas por outros, enquanto eles estão na lista do proprietários de complementos

  • um complemento específico pode ser apagado e editado apenas pela equipe de usuários e pelos proprietários do complemento

  • se um usuário sem permissão plugins.can_approve carrega uma nova versão, a versão do plugin é automaticamente não aprovado.

Gerenciamento de confiança

Os membros da equipe podem conceder permissão para criadores de complementos selecionado definindo permissão plugins.can_approve através da aplicação front-end.

A visão de detalhes do complemento oferece links diretos para conceder permissão para o criador do complemento ou o proprietários do complemento.

Validação

Metadados do complemento são automaticamente importados e validados a partir do pacote compactado quando o complemento é carregado.

Aqui estão algumas regras de validação que você deve estar ciente quando desejar fazer o upload de um complemento no repositório oficial:

  1. o nome da pasta principal que contém o seu complemento deve conter contém apenas caracteres ASCII (A-Z e a-z), números e caracteres de sublinhado (_) e menos (-), também não pode começar com um dígito

  2. metadata.txt é necessário

  3. todos metadados requeridos e que devem estar presentes estão listados em metadata table

  4. o campo versão metadados deve ser exclusivo

Estrutura dos complementos

Seguindo as regras de validação, o pacote compactado (.zip) de seu plugin deve ter uma estrutura específica para ser validado como um plugin funcional. Como o plugin será descompactado dentro da pasta de plugins de usuários ele deve ter seu próprio diretório dentro do arquivo .zip para não interfirir em outros plugins. Arquivos obrigatórios: metadata.txt e __init__.py. Seria melhor se tivesse um README e também um ícone representando o plugin (resources.qrc). A seguir, um exemplo de como um plugin.zip deve se parecer.

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