上一节讲到了如何配置PyQGIS开发环境,以及使用Eclipse+PyDev工具进行QGIS开发调试。
前面该说的都已经说了,以后就不废话,直接进入正题了。
摘要
本文将会详细阐述如何使用Python创建QGIS插件。
创建插件
最简单的插件开发工程构建方法,无非是使用Plugin Builder这个插件了。
首先,打开QGIS软件,在菜单栏选择“Plugins -> Manage and Install Plugins”,搜索并添加“Plugin Builder”这个插件。
安装成功后,打开”Plugin Builder”插件的对话框,填写相应的项目信息,如下图。
这里,我将插件命名为“MyPlugin”,当然,你也可以取任何名字,只要填上就行。然后点击“Next”按钮。
接下来弹出的是“About”窗口,你可以填写一些信息。然后继续“Next”。
之后,在出现的窗口中,需要选择插件的类型,以及填写插件在QGIS软件菜单栏显示的名称。类型我选择了默认的“Tool button with dialog”也就是带按钮的窗口。名称我这里依然填写“MyPlugin”。继续点击“Next”。
接下来弹出的窗口表示插件工程需要生成的模板,保持默认就可以了,继续“Next”。
到这里之后,就是填写“Bug tracker”以及“Repository”等信息,这些信息会直接关联到QGIS的插件管理平台。也就说,你的插件发布以后,就会被所有使用QGIS的“Mange and Install Plugins”工具的人看到,并且可以下载使用。“Bug tracker”和“Repository”可以填写以下Github的地址。
- Bug tracker : https://github.com/GeospatialPython/Learn/issues
- Repository : https://github.com/GeospatialPython/Learn/
当然,我们这里的插件只是个示范,所以,把“Flag the plugin as experimental”打上勾。
再次点击“Next”以后,会弹出插件保存的位置对话框。为了跟其他QGIS插件保持一致,笔者推荐使用QGIS插件的标准位置,也就是:
C:\Users\<你的用户名>\.qgis2\python\plugins
当然,不使用这个位置也可以,但是就需要使用“QGIS_PLUGINPATH”这个环境变量来指定你的插件位置,否则QGIS软件无法加载该插件。配置方法可以是写入QGIS启动之前的“startup.py”文件里面,也可以在QGIS软件中使用“Settings -> Options -> System -> Environment”进行配置。具体方法在这里就不展开了。
最后,点击“OK”按钮,我们的插件工程就创建好了。
编译插件工程
使用“Plugin Builder”生成的插件工程是直接可用编译生成的。接下来,我们需要使用到“pyrcc4”这个工具来进行工程编译。
“pyrcc4”这个是一个命令行工具,有两种方式可以找到他。第一种方式是直接使用Windows下的命令行工具,如果输入“pyrcc4”,弹出如下图所示的信息,则表示这个工具是可用的。