Vector-Tiles-Reader-QGIS-Plugin 项目教程

1. 项目的目录结构及介绍

Vector-Tiles-Reader-QGIS-Plugin/
├── README.md
├── requirements-dev.txt
├── setup.cfg
├── z_install.bat
├── z_uninstall.bat
├── VectorTilesReader/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── utils.py
│   └── ...
├── tests/
│   ├── test_main.py
│   ├── test_config.py
│   └── ...
└── ...

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• requirements-dev.txt: 开发环境所需的依赖包列表。
• setup.cfg: 项目的配置文件，包含安装和构建的配置信息。
• z_install.bat: Windows 系统下的安装脚本。
• z_uninstall.bat: Windows 系统下的卸载脚本。
• VectorTilesReader/: 项目的主要代码目录，包含插件的核心功能实现。
  • init.py: 模块初始化文件。
  • main.py: 项目的启动文件，负责初始化和启动插件。
  • config.py: 项目的配置文件，包含插件的配置参数。
  • utils.py: 工具函数文件，包含一些通用的辅助函数。
• tests/: 测试代码目录，包含项目的单元测试和集成测试。

2. 项目的启动文件介绍

main.py

main.py 是 Vector-Tiles-Reader-QGIS-Plugin 项目的启动文件，负责初始化和启动插件。以下是该文件的主要功能介绍：

from qgis.core import QgsApplication
from VectorTilesReader.plugin import VectorTilesReaderPlugin

def run():
    # 初始化 QGIS 应用程序
    qgs = QgsApplication([], True)
    qgs.initQgis()

    # 加载插件
    plugin = VectorTilesReaderPlugin()
    plugin.initGui()

    # 运行 QGIS 应用程序
    qgs.exec_()
    qgs.exitQgis()

if __name__ == "__main__":
    run()

功能介绍

• 初始化 QGIS 应用程序: 通过 QgsApplication 初始化 QGIS 应用程序。
• 加载插件: 实例化 VectorTilesReaderPlugin 类，并调用 initGui() 方法加载插件的图形界面。
• 运行 QGIS 应用程序: 调用 exec_() 方法启动 QGIS 应用程序，并在退出时调用 exitQgis() 方法清理资源。

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是项目的配置文件，包含安装和构建的配置信息。以下是该文件的主要内容：

[metadata]
name = Vector-Tiles-Reader-QGIS-Plugin
version = 1.0.0
description = QGIS Python plugin which reads Mapbox Vector Tiles from a server, a local MBTiles file or a directory
author = Martin Boos
license = GPL-2.0

[options]
packages = find:
include_package_data = True
install_requires =
    qgis
    requests

[options.entry_points]
qgis.plugins =
    vector_tiles_reader = VectorTilesReader.main:run

配置项介绍

• [metadata]: 项目的元数据信息，包括项目名称、版本、描述、作者和许可证。
• [options]: 安装选项，指定需要包含的包和依赖项。
  • packages: 使用 find: 自动查找并包含所有包。
  • include_package_data: 包含非 Python 文件（如配置文件、资源文件等）。
  • install_requires: 列出项目所需的依赖包。
• [options.entry_points]: 插件的入口点配置，指定插件的入口函数。

通过以上配置，setup.cfg 文件确保了插件的正确安装和运行。