PyQGisCookbook--插件发布(十八/4)

---

发布插件

警

• 元数据和名称

• 代码和帮助

• 官方Python插件仓库

  • 权限

  • 信托管理

  • 验证方式

  • 插件结构

一旦您的插件准备就绪，并且您认为该插件可能对某些人有帮助，请立即将其上传到Official Python插件存储库。在该页面上，您还可以找到有关如何准备插件以使其与插件安装程序配合使用的打包指南，如果您想建立自己的插件存储库，请创建一个简单的XML文件，其中将列出插件及其元数据。

请特别注意以下建议：

元数据和名称

• 避免使用与现有插件相似的名称

• 如果您的插件具有与现有插件相似的功能，请在“关于”字段中说明差异，以便用户无需安装和测试即可知道要使用哪个插件。

• 避免在插件本身的名称中重复“ plugin”

• 用于1行描述元数据中的描述字段，关于字段用于获取更详细的说明

• 用GitHub，GitLab，Bitbucket等进行代码仓库，错误跟踪，将大大提高协作的效率。

• 谨慎选择标签：避免使用那些无关紧要的标签（例如矢量），其他人已经使用过的标签（请参见插件网站）

• 添加适当的图标，不要保留默认图标；有关要使用的样式的建议，请参见QGIS界面

编码和帮助

• 在仓库中不包括生成的文件（ui _ *.py，resources_rc.py，其它生成的帮助文件…）和无用的文件（例如.gitignore）

• 将插件添加到适当的菜单（Vector, Raster, Web, Database）

• 在适当的时候（插件执行分析），请考虑将插件添加为处理框架的子插件：这将允许用户批量运行它，将其集成到更复杂的工作流程中，并使您摆脱设计界面的负担。

• 至少包括最少的文档，如果对测试和理解有用还应包括样本数据。

官方Python插件仓库

您可以在https://plugins.qgis.org/找到官方的 Python插件仓库 。

为了使用官方仓库，您必须从OSGEO Web门户获取OSGEO ID 。

上传插件后，获得工作人员的批准后你会收到通知。

TODO：

插入指向管理文档的链接

权限

这些规则已在官方插件仓库中实现：

• 每个注册用户都可以添加一个新插件

• 员工用户可以批准或拒绝所有插件版本

• 具有特殊权限插件的用户。can_approve会自动批准他们上传的版本

• 具有特殊权限（plugins.can_approve）的用户可以批准其他人上传的版本，只要它们在插件所有者列表中即可

• 特定的插件只能由工作人员和插件所有者删除和编辑

• 如果没有plugins.can_approve权限的用户上传新版本，则该插件版本将自动不被批准。

信托管理

员工可以通过前端应用程序向设置plugins.can_approve权限的选定插件创建者 授予信任。

插件详细信息视图提供直接链接，以向插件创建者或插件所有者授予信任。

验证

上载插件时，会自动从压缩包中导入并验证插件的元数据。

当您要将插件上传到官方仓库的一些验证规则：

1. 包含插件的主文件夹的名称必须仅包含ASCII字符（AZ和az），数字以及下划线（_）和减号（-）的字符，也不能以数字开头

2. metadata.txt 是必须的

3. 元数据表中列出的所有必需元数据都 必须存在

4. 该版本的元数据字段必须是唯一的

插件结构

遵循验证规则，插件的压缩（.zip）软件包必须具有特定的结构才能作为功能性插件进行验证。由于该插件将在用户plugins文件夹中解压缩，因此它必须在.zip文件中具有其自己的目录，以免干扰其他插件。强制性文件为：metadata.txt和__init__.py。但是最好有一个README和一个图标来表示插件（resources.qrc）。以下是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

下一个   前一个

---

©版权所有2002-现在，QGIS项目 最近更新于2020年4月3日09:14。

使用Sphinx使用Read the Docs提供的主题构建。