├── .gitignore
├── Makefile
├── Oxygen480-categories-applications-development.svg
├── README.rst
├── __init__.py
├── docs
    ├── .nojekyll
    ├── _config.yml
    ├── _images
    │   ├── compile_failed.png
    │   ├── generating.png
    │   ├── plugin_menu.png
    │   ├── plugin_results.png
    │   ├── plugin_test.png
    │   ├── redundant_menu.png
    │   ├── wizard_about.png
    │   ├── wizard_helpers.png
    │   ├── wizard_publication_info.png
    │   ├── wizard_required_info.png
    │   └── wizard_template.png
    ├── _sources
    │   ├── index.rst.txt
    │   └── index.txt
    ├── _static
    │   ├── ajax-loader.gif
    │   ├── basic.css
    │   ├── comment-bright.png
    │   ├── comment-close.png
    │   ├── comment.png
    │   ├── dialog-note.png
    │   ├── dialog-seealso.png
    │   ├── dialog-todo.png
    │   ├── dialog-topic.png
    │   ├── dialog-warning.png
    │   ├── doctools.js
    │   ├── down-pressed.png
    │   ├── down.png
    │   ├── epub.css
    │   ├── file.png
    │   ├── footerbg.png
    │   ├── headerbg.png
    │   ├── ie6.css
    │   ├── jquery-1.11.1.js
    │   ├── jquery-3.1.0.js
    │   ├── jquery.js
    │   ├── middlebg.png
    │   ├── minus.png
    │   ├── plus.png
    │   ├── pygments.css
    │   ├── pyramid.css
    │   ├── searchtools.js
    │   ├── transparent.gif
    │   ├── underscore-1.3.1.js
    │   ├── underscore.js
    │   ├── up-pressed.png
    │   ├── up.png
    │   └── websupport.js
    ├── genindex.html
    ├── index.html
    ├── objects.inv
    ├── search.html
    └── searchindex.js
├── help
    ├── Makefile
    └── source
    │   ├── conf.py
    │   ├── images
    │       ├── compile_failed.png
    │       ├── generating.png
    │       ├── plugin_menu.png
    │       ├── plugin_results.png
    │       ├── plugin_test.png
    │       ├── redundant_menu.png
    │       ├── wizard_about.png
    │       ├── wizard_helpers.png
    │       ├── wizard_publication_info.png
    │       ├── wizard_required_info.png
    │       └── wizard_template.png
    │   └── index.rst
├── icon.png
├── icon.readme
├── icon.svg
├── icon.xcf
├── metadata.txt
├── pb_tool.cfg
├── plugin_builder.png
├── plugin_builder.py
├── plugin_builder_dialog.py
├── plugin_builder_dialog_base.ui
├── plugin_specification.py
├── plugin_templates
    ├── __init__.py
    ├── plugin_template.py
    ├── processing_provider
    │   ├── __init__.py
    │   ├── plugin_template.py
    │   ├── template
    │   │   ├── __init__.tmpl
    │   │   ├── module_name.tmpl
    │   │   ├── module_name_algorithm.tmpl
    │   │   ├── module_name_provider.tmpl
    │   │   ├── readme.tmpl
    │   │   └── results.tmpl
    │   └── wizard_form_base.ui
    ├── shared
    │   ├── Makefile.tmpl
    │   ├── help
    │   │   ├── Makefile
    │   │   ├── make.bat
    │   │   └── source
    │   │   │   ├── conf.py.tmpl
    │   │   │   └── index.rst.tmpl
    │   ├── i18n
    │   │   └── af.ts
    │   ├── pb_tool.tmpl
    │   ├── plugin_upload.py
    │   ├── pylintrc
    │   ├── scripts
    │   │   ├── compile-strings.sh
    │   │   ├── run-env-linux.sh
    │   │   └── update-strings.sh
    │   └── test
    │   │   ├── __init__.py
    │   │   ├── qgis_interface.py
    │   │   ├── tenbytenraster.asc
    │   │   ├── tenbytenraster.asc.aux.xml
    │   │   ├── tenbytenraster.keywords
    │   │   ├── tenbytenraster.lic
    │   │   ├── tenbytenraster.prj
    │   │   ├── tenbytenraster.qml
    │   │   ├── test_init.py
    │   │   ├── test_qgis_environment.py
    │   │   ├── test_translations.py
    │   │   └── utilities.py
    ├── toolbutton_with_dialog
    │   ├── __init__.py
    │   ├── plugin_template.py
    │   ├── template
    │   │   ├── __init__.tmpl
    │   │   ├── icon.png
    │   │   ├── module_name.tmpl
    │   │   ├── module_name_dialog.tmpl
    │   │   ├── module_name_dialog_base.ui.tmpl
    │   │   ├── readme.tmpl
    │   │   ├── resources.tmpl
    │   │   ├── results.tmpl
    │   │   └── test
    │   │   │   ├── test_module_name_dialog.templ
    │   │   │   └── test_resources.templ
    │   └── wizard_form_base.ui
    └── toolbutton_with_dockwidget
    │   ├── __init__.py
    │   ├── plugin_template.py
    │   ├── template
    │       ├── __init__.tmpl
    │       ├── icon.png
    │       ├── module_name.tmpl
    │       ├── module_name_dockwidget.tmpl
    │       ├── module_name_dockwidget_base.ui
    │       ├── module_name_dockwidget_base.ui.tmpl
    │       ├── readme.tmpl
    │       ├── resources.tmpl
    │       ├── results.tmpl
    │       └── test
    │       │   ├── test_module_name_dockwidget.templ
    │       │   └── test_resources.templ
    │   └── wizard_form_base.ui
├── pylintrc
├── qgis_dirs.py
├── resources.qrc
├── result_dialog.py
├── results_dialog_base.ui
├── run-env-linux.sh
├── select_tags_dialog.py
├── select_tags_dialog_base.ui
├── taglist.txt
└── test
    ├── __init__.py
    ├── qgis_interface.py
    ├── test_builder.py
    └── utilities.py


/.gitignore:
--------------------------------------------------------------------------------
 1 | # ignore swap files
 2 | *swp
 3 | plugin_template/*swp
 4 | # ignore compiled python files
 5 | *pyc
 6 | plugin_template/*pyc
 7 | .idea
 8 | .coverage
 9 | .noseids
10 | nohup.out
11 | resources.py
12 | 
13 | # ignore the help build dir
14 | help/build
15 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
  1 | #/***************************************************************************
  2 | #    PluginBuilder
  3 | #
  4 | #    Creates a QGIS plugin template for use as a starting point in plugin
  5 | #    development.
  6 | #                             -------------------
  7 | #        begin                : 2011-01-20
  8 | #        git sha              : $Format:%H$
  9 | #        copyright            : (C) 2011 by GeoApt LLC
 10 | #        email                : gsherman@geoapt.com
 11 | # ***************************************************************************/
 12 | #
 13 | #/***************************************************************************
 14 | # *                                                                         *
 15 | # *   This program is free software; you can redistribute it and/or modify  *
 16 | # *   it under the terms of the GNU General Public License as published by  *
 17 | # *   the Free Software Foundation; either version 2 of the License, or     *
 18 | # *   (at your option) any later version.                                   *
 19 | # *                                                                         *
 20 | # ***************************************************************************/
 21 | # Makefile for a PyQGIS plugin
 22 | #
 23 | 
 24 | DOTQGIS=.qgis3
 25 | 
 26 | PLUGINNAME=pluginbuilder3
 27 | 
 28 | PY_FILES = plugin_builder.py plugin_builder_dialog.py result_dialog.py __init__.py plugin_specification.py select_tags_dialog.py
 29 | 
 30 | UI_FILES = plugin_builder_dialog_base.ui results_dialog_base.ui select_tags_dialog_base.ui
 31 | 
 32 | TEMPLATE_DIR = plugin_templates
 33 | 
 34 | EXTRAS = icon.png plugin_builder.png metadata.txt taglist.txt
 35 | 
 36 | HELP_BUILD = help/build/html/*
 37 | 
 38 | RESOURCE_FILES = resources.py
 39 | PY_UI_FILES = $(UI_FILES:.ui=.py)
 40 | 
 41 | default: compile
 42 | 
 43 | compile: $(PY_UI_FILES) $(RESOURCE_FILES)
 44 | 
 45 | %.py : %.qrc
 46 | 	pyrcc5 -o $@ $<
 47 | 
 48 | %.py : %.ui
 49 | 	pyuic5 -o $@ $<
 50 | 
 51 | # The deploy  target only works on unix like operating system where
 52 | # the Python plugin directory is located at:
 53 | # $HOME/$(DOTQGIS)/python/plugins
 54 | deploy: compile
 55 | 	mkdir -p $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)
 56 | 	mkdir -p $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)/help
 57 | 	cp -vf $(PY_FILES) $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)
 58 | 	cp -vf $(UI_FILES) $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)
 59 | 	cp -vf $(RESOURCE_FILES) $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)
 60 | 	cp -vf $(EXTRAS) $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)
 61 | 	cp -rvf $(TEMPLATE_DIR) $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)
 62 | 	cp -rvf $(HELP_BUILD) $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)/help
 63 | 
 64 | # remove the deployed plugin
 65 | dclean:
 66 | 	rm -rf $(HOME)/$(DOTQGIS)/python/plugins/$(PLUGINNAME)
 67 | 
 68 | zip: dclean deploy
 69 | 	rm -f $(PLUGINNAME).zip
 70 | 	cd $(HOME)/$(DOTQGIS)/python/plugins; zip -9vr $(CURDIR)/$(PLUGINNAME).zip $(PLUGINNAME)
 71 | 
 72 | 
 73 | # Create a zip package. Requires passing a valid commit or tag as follows:
 74 | #   make package VERSION=Version_0.3.2
 75 | # Get the last commit hash
 76 | COMMITHASH=$(shell git rev-parse HEAD)
 77 | package: compile
 78 | 		rm -f $(PLUGINNAME).zip
 79 | 		git archive --prefix=$(PLUGINNAME)/ -o $(PLUGINNAME).zip $(COMMITHASH)
 80 | 		@echo "Created package: $(PLUGINNAME).zip"
 81 | 
 82 | clean:
 83 | 	rm $(RESOURCE_FILES)
 84 | 
 85 | test: compile
 86 | 	@echo
 87 | 	@echo "----------------------"
 88 | 	@echo "Regression Test Suite"
 89 | 	@echo "----------------------"
 90 | 
 91 | 	@# Preceding dash means that make will continue in case of errors
 92 | 	@-export PYTHONPATH=`pwd`:$(PYTHONPATH); \
 93 | 		export QGIS_DEBUG=0; \
 94 | 		export QGIS_LOG_FILE=/dev/null; \
 95 | 		nosetests -v --with-id --with-coverage --cover-package=. \
 96 | 		3>&1 1>&2 2>&3 3>&- || true
 97 | 	@echo
 98 | 	@echo "----------------------"
 99 | 	@echo "If you get a 'no module named qgis.core error, try sourcing"
100 | 	@echo "the helper script we have provided first then run make test."
101 | 	@echo "e.g. source run-env-linux.sh <path to qgis install>; make test"
102 | 	@echo "----------------------"
103 | 
104 | 
105 | 
106 | pylint:
107 | 	@echo
108 | 	@echo "-----------------"
109 | 	@echo "Pylint violations"
110 | 	@echo "-----------------"
111 | 	@pylint --reports=n --rcfile=pylintrc . || true
112 | 
113 | 
114 | # Run pep8 style checking
115 | #http://pypi.python.org/pypi/pep8
116 | pep8:
117 | 	@echo
118 | 	@echo "-----------"
119 | 	@echo "PEP8 issues"
120 | 	@echo "-----------"
121 | 	@pep8 --repeat --ignore=E203,E121,E122,E123,E124,E125,E126,E127,E128 --exclude pydev,resources.py,conf.py . || true
122 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
 1 | NOTE
 2 | ====
 3 | 
 4 | **QGIS 3 development now takes place in master branch.**
 5 | **QGIS 2 version of the plugin is in the LTR_2.x branch**
 6 | 
 7 | QGIS Plugin Builder
 8 | ===================
 9 | 
10 | .. image:: https://badges.gitter.im/Join%20Chat.svg
11 |    :alt: Join the chat at https://gitter.im/g-sherman/Qgis-Plugin-Builder
12 |    :target: https://gitter.im/g-sherman/Qgis-Plugin-Builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
13 | 
14 | .. figure:: help/source/images/wizard_required_info.png
15 | 
16 | This is a QGIS plugin that generates a QGIS plugin template for use in
17 | creating custom plugins.
18 | 
19 | Documentation
20 | -------------
21 | 
22 | See the `help`_ documentation about using the plugin.
23 | 
24 | .. _help: help/source/index.rst
25 | 
26 | Contributing
27 | ------------
28 | 
29 | New plugin templates can be added by creating a subdirectory below ``plugin_templates`` and registering the template in ``plugin_templates/__init__.py``
30 | 


--------------------------------------------------------------------------------
/__init__.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """
 3 | /***************************************************************************
 4 |     PluginBuilder
 5 | 
 6 |     Creates a QGIS plugin template for use as a starting point in plugin
 7 |     development.
 8 |                              -------------------
 9 |         begin                : 2011-01-20
10 |         copyright            : (C) 2011-2014 by GeoApt LLC
11 |         email                : gsherman@geoapt.com
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 |  This script initializes the plugin, making it known to QGIS.
23 | """
24 | 
25 | 
26 | # pylint: disable=C0103
27 | # noinspection PyPep8Naming
28 | def classFactory(iface):
29 |     """Load PluginBuilder class from file PluginBuilder.
30 | 
31 |     :param iface: A QGIS interface instance.
32 |     :type iface: QgsInterface
33 |     """
34 |     from .plugin_builder import PluginBuilder
35 |     return PluginBuilder(iface)
36 | # pylint: enable=C0103
37 | 


--------------------------------------------------------------------------------
/docs/.nojekyll:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/.nojekyll


--------------------------------------------------------------------------------
/docs/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-slate


--------------------------------------------------------------------------------
/docs/_images/compile_failed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/compile_failed.png


--------------------------------------------------------------------------------
/docs/_images/generating.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/generating.png


--------------------------------------------------------------------------------
/docs/_images/plugin_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/plugin_menu.png


--------------------------------------------------------------------------------
/docs/_images/plugin_results.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/plugin_results.png


--------------------------------------------------------------------------------
/docs/_images/plugin_test.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/plugin_test.png


--------------------------------------------------------------------------------
/docs/_images/redundant_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/redundant_menu.png


--------------------------------------------------------------------------------
/docs/_images/wizard_about.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/wizard_about.png


--------------------------------------------------------------------------------
/docs/_images/wizard_helpers.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/wizard_helpers.png


--------------------------------------------------------------------------------
/docs/_images/wizard_publication_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/wizard_publication_info.png


--------------------------------------------------------------------------------
/docs/_images/wizard_required_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/wizard_required_info.png


--------------------------------------------------------------------------------
/docs/_images/wizard_template.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_images/wizard_template.png


--------------------------------------------------------------------------------
/docs/_static/ajax-loader.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/ajax-loader.gif


--------------------------------------------------------------------------------
/docs/_static/comment-bright.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/comment-bright.png


--------------------------------------------------------------------------------
/docs/_static/comment-close.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/comment-close.png


--------------------------------------------------------------------------------
/docs/_static/comment.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/comment.png


--------------------------------------------------------------------------------
/docs/_static/dialog-note.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/dialog-note.png


--------------------------------------------------------------------------------
/docs/_static/dialog-seealso.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/dialog-seealso.png


--------------------------------------------------------------------------------
/docs/_static/dialog-todo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/dialog-todo.png


--------------------------------------------------------------------------------
/docs/_static/dialog-topic.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/dialog-topic.png


--------------------------------------------------------------------------------
/docs/_static/dialog-warning.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/dialog-warning.png


--------------------------------------------------------------------------------
/docs/_static/down-pressed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/down-pressed.png


--------------------------------------------------------------------------------
/docs/_static/down.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/down.png


--------------------------------------------------------------------------------
/docs/_static/epub.css:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * default.css_t
  3 |  * ~~~~~~~~~~~~~
  4 |  *
  5 |  * Sphinx stylesheet -- default theme.
  6 |  *
  7 |  * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
  8 |  * :license: BSD, see LICENSE for details.
  9 |  *
 10 |  */
 11 | 
 12 | @import url("basic.css");
 13 | 
 14 | /* -- page layout ----------------------------------------------------------- */
 15 | 
 16 | body {
 17 |     font-family: {{ theme_bodyfont }};
 18 |     font-size: 100%;
 19 |     background-color: {{ theme_footerbgcolor }};
 20 |     color: #000;
 21 |     margin: 0;
 22 |     padding: 0;
 23 | }
 24 | 
 25 | div.document {
 26 |     background-color: {{ theme_sidebarbgcolor }};
 27 | }
 28 | 
 29 | div.documentwrapper {
 30 |     float: left;
 31 |     width: 100%;
 32 | }
 33 | 
 34 | div.bodywrapper {
 35 |     margin: 0 0 0 230px;
 36 | }
 37 | 
 38 | div.body {
 39 |     background-color: {{ theme_bgcolor }};
 40 |     color: {{ theme_textcolor }};
 41 |     padding: 0 20px 30px 20px;
 42 | }
 43 | 
 44 | {%- if theme_rightsidebar|tobool %}
 45 | div.bodywrapper {
 46 |     margin: 0 230px 0 0;
 47 | }
 48 | {%- endif %}
 49 | 
 50 | div.footer {
 51 |     color: {{ theme_footertextcolor }};
 52 |     width: 100%;
 53 |     padding: 9px 0 9px 0;
 54 |     text-align: center;
 55 |     font-size: 75%;
 56 | }
 57 | 
 58 | div.footer a {
 59 |     color: {{ theme_footertextcolor }};
 60 |     text-decoration: underline;
 61 | }
 62 | 
 63 | div.related {
 64 |     background-color: {{ theme_relbarbgcolor }};
 65 |     line-height: 30px;
 66 |     color: {{ theme_relbartextcolor }};
 67 | }
 68 | 
 69 | div.related a {
 70 |     color: {{ theme_relbarlinkcolor }};
 71 | }
 72 | 
 73 | div.sphinxsidebar {
 74 |     {%- if theme_stickysidebar|tobool %}
 75 |     top: 30px;
 76 |     bottom: 0;
 77 |     margin: 0;
 78 |     position: fixed;
 79 |     overflow: auto;
 80 |     height: auto;
 81 |     {%- endif %}
 82 |     {%- if theme_rightsidebar|tobool %}
 83 |     float: right;
 84 |     {%- if theme_stickysidebar|tobool %}
 85 |     right: 0;
 86 |     {%- endif %}
 87 |     {%- endif %}
 88 | }
 89 | 
 90 | {%- if theme_stickysidebar|tobool %}
 91 | /* this is nice, but it it leads to hidden headings when jumping
 92 |    to an anchor */
 93 | /*
 94 | div.related {
 95 |     position: fixed;
 96 | }
 97 | 
 98 | div.documentwrapper {
 99 |     margin-top: 30px;
100 | }
101 | */
102 | {%- endif %}
103 | 
104 | div.sphinxsidebar h3 {
105 |     font-family: {{ theme_headfont }};
106 |     color: {{ theme_sidebartextcolor }};
107 |     font-size: 1.4em;
108 |     font-weight: normal;
109 |     margin: 0;
110 |     padding: 0;
111 | }
112 | 
113 | div.sphinxsidebar h3 a {
114 |     color: {{ theme_sidebartextcolor }};
115 | }
116 | 
117 | div.sphinxsidebar h4 {
118 |     font-family: {{ theme_headfont }};
119 |     color: {{ theme_sidebartextcolor }};
120 |     font-size: 1.3em;
121 |     font-weight: normal;
122 |     margin: 5px 0 0 0;
123 |     padding: 0;
124 | }
125 | 
126 | div.sphinxsidebar p {
127 |     color: {{ theme_sidebartextcolor }};
128 | }
129 | 
130 | div.sphinxsidebar p.topless {
131 |     margin: 5px 10px 10px 10px;
132 | }
133 | 
134 | div.sphinxsidebar ul {
135 |     margin: 10px;
136 |     padding: 0;
137 |     color: {{ theme_sidebartextcolor }};
138 | }
139 | 
140 | div.sphinxsidebar a {
141 |     color: {{ theme_sidebarlinkcolor }};
142 | }
143 | 
144 | div.sphinxsidebar input {
145 |     border: 1px solid {{ theme_sidebarlinkcolor }};
146 |     font-family: sans-serif;
147 |     font-size: 1em;
148 | }
149 | 
150 | {% if theme_collapsiblesidebar|tobool %}
151 | /* for collapsible sidebar */
152 | div#sidebarbutton {
153 |     background-color: {{ theme_sidebarbtncolor }};
154 | }
155 | {% endif %}
156 | 
157 | /* -- hyperlink styles ------------------------------------------------------ */
158 | 
159 | a {
160 |     color: {{ theme_linkcolor }};
161 |     text-decoration: none;
162 | }
163 | 
164 | a:visited {
165 |     color: {{ theme_visitedlinkcolor }};
166 |     text-decoration: none;
167 | }
168 | 
169 | a:hover {
170 |     text-decoration: underline;
171 | }
172 | 
173 | {% if theme_externalrefs|tobool %}
174 | a.external {
175 |    text-decoration: none;
176 |    border-bottom: 1px dashed {{ theme_linkcolor }};
177 | }
178 | 
179 | a.external:hover {
180 |    text-decoration: none;
181 |    border-bottom: none;
182 | }
183 | 
184 | a.external:visited {
185 |     text-decoration: none;
186 |     border-bottom: 1px dashed {{ theme_visitedlinkcolor }};
187 | }
188 | {% endif %}
189 | 
190 | /* -- body styles ----------------------------------------------------------- */
191 | 
192 | div.body h1,
193 | div.body h2,
194 | div.body h3,
195 | div.body h4,
196 | div.body h5,
197 | div.body h6 {
198 |     font-family: {{ theme_headfont }};
199 |     background-color: {{ theme_headbgcolor }};
200 |     font-weight: normal;
201 |     color: {{ theme_headtextcolor }};
202 |     border-bottom: 1px solid #ccc;
203 |     margin: 20px -20px 10px -20px;
204 |     padding: 3px 0 3px 10px;
205 | }
206 | 
207 | div.body h1 { margin-top: 0; font-size: 200%; }
208 | div.body h2 { font-size: 160%; }
209 | div.body h3 { font-size: 140%; }
210 | div.body h4 { font-size: 120%; }
211 | div.body h5 { font-size: 110%; }
212 | div.body h6 { font-size: 100%; }
213 | 
214 | a.headerlink {
215 |     color: {{ theme_headlinkcolor }};
216 |     font-size: 0.8em;
217 |     padding: 0 4px 0 4px;
218 |     text-decoration: none;
219 | }
220 | 
221 | a.headerlink:hover {
222 |     background-color: {{ theme_headlinkcolor }};
223 |     color: white;
224 | }
225 | 
226 | div.body p, div.body dd, div.body li {
227 |     text-align: justify;
228 |     line-height: 130%;
229 | }
230 | 
231 | div.admonition p.admonition-title + p {
232 |     display: inline;
233 | }
234 | 
235 | div.admonition p {
236 |     margin-bottom: 5px;
237 | }
238 | 
239 | div.admonition pre {
240 |     margin-bottom: 5px;
241 | }
242 | 
243 | div.admonition ul, div.admonition ol {
244 |     margin-bottom: 5px;
245 | }
246 | 
247 | div.note {
248 |     background-color: #eee;
249 |     border: 1px solid #ccc;
250 | }
251 | 
252 | div.seealso {
253 |     background-color: #ffc;
254 |     border: 1px solid #ff6;
255 | }
256 | 
257 | div.topic {
258 |     background-color: #eee;
259 | }
260 | 
261 | div.warning {
262 |     background-color: #ffe4e4;
263 |     border: 1px solid #f66;
264 | }
265 | 
266 | p.admonition-title {
267 |     display: inline;
268 | }
269 | 
270 | p.admonition-title:after {
271 |     content: ":";
272 | }
273 | 
274 | pre {
275 |     padding: 5px;
276 |     background-color: {{ theme_codebgcolor }};
277 |     color: {{ theme_codetextcolor }};
278 |     line-height: 120%;
279 |     border: 1px solid #ac9;
280 |     border-left: none;
281 |     border-right: none;
282 | }
283 | 
284 | code {
285 |     background-color: #ecf0f3;
286 |     padding: 0 1px 0 1px;
287 |     font-size: 0.95em;
288 | }
289 | 
290 | th {
291 |     background-color: #ede;
292 | }
293 | 
294 | .warning code {
295 |     background: #efc2c2;
296 | }
297 | 
298 | .note code {
299 |     background: #d6d6d6;
300 | }
301 | 
302 | .viewcode-back {
303 |     font-family: {{ theme_bodyfont }};
304 | }
305 | 
306 | div.viewcode-block:target {
307 |     background-color: #f4debf;
308 |     border-top: 1px solid #ac9;
309 |     border-bottom: 1px solid #ac9;
310 | }
311 | 


--------------------------------------------------------------------------------
/docs/_static/file.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/file.png


--------------------------------------------------------------------------------
/docs/_static/footerbg.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/footerbg.png


--------------------------------------------------------------------------------
/docs/_static/headerbg.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/headerbg.png


--------------------------------------------------------------------------------
/docs/_static/ie6.css:
--------------------------------------------------------------------------------
1 | * html img,
2 | * html .png{position:relative;behavior:expression((this.runtimeStyle.behavior="none")&&(this.pngSet?this.pngSet=true:(this.nodeName == "IMG" && this.src.toLowerCase().indexOf('.png')>-1?(this.runtimeStyle.backgroundImage = "none",
3 | this.runtimeStyle.filter = "progid:DXImageTransform.Microsoft.AlphaImageLoader(src='" + this.src + "',sizingMethod='image')",
4 | this.src = "_static/transparent.gif"):(this.origBg = this.origBg? this.origBg :this.currentStyle.backgroundImage.toString().replace('url("','').replace('")',''),
5 | this.runtimeStyle.filter = "progid:DXImageTransform.Microsoft.AlphaImageLoader(src='" + this.origBg + "',sizingMethod='crop')",
6 | this.runtimeStyle.backgroundImage = "none")),this.pngSet=true)
7 | );}
8 | 


--------------------------------------------------------------------------------
/docs/_static/middlebg.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/middlebg.png


--------------------------------------------------------------------------------
/docs/_static/minus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/minus.png


--------------------------------------------------------------------------------
/docs/_static/plus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/plus.png


--------------------------------------------------------------------------------
/docs/_static/pygments.css:
--------------------------------------------------------------------------------
 1 | .highlight .hll { background-color: #ffffcc }
 2 | .highlight  { background: #eeffcc; }
 3 | .highlight .c { color: #408090; font-style: italic } /* Comment */
 4 | .highlight .err { border: 1px solid #FF0000 } /* Error */
 5 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */
 6 | .highlight .o { color: #666666 } /* Operator */
 7 | .highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
 8 | .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
 9 | .highlight .cp { color: #007020 } /* Comment.Preproc */
10 | .highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
11 | .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
12 | .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
13 | .highlight .gd { color: #A00000 } /* Generic.Deleted */
14 | .highlight .ge { font-style: italic } /* Generic.Emph */
15 | .highlight .gr { color: #FF0000 } /* Generic.Error */
16 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
17 | .highlight .gi { color: #00A000 } /* Generic.Inserted */
18 | .highlight .go { color: #333333 } /* Generic.Output */
19 | .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
20 | .highlight .gs { font-weight: bold } /* Generic.Strong */
21 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
22 | .highlight .gt { color: #0044DD } /* Generic.Traceback */
23 | .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
24 | .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
25 | .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
26 | .highlight .kp { color: #007020 } /* Keyword.Pseudo */
27 | .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
28 | .highlight .kt { color: #902000 } /* Keyword.Type */
29 | .highlight .m { color: #208050 } /* Literal.Number */
30 | .highlight .s { color: #4070a0 } /* Literal.String */
31 | .highlight .na { color: #4070a0 } /* Name.Attribute */
32 | .highlight .nb { color: #007020 } /* Name.Builtin */
33 | .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
34 | .highlight .no { color: #60add5 } /* Name.Constant */
35 | .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
36 | .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
37 | .highlight .ne { color: #007020 } /* Name.Exception */
38 | .highlight .nf { color: #06287e } /* Name.Function */
39 | .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
40 | .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
41 | .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
42 | .highlight .nv { color: #bb60d5 } /* Name.Variable */
43 | .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
44 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */
45 | .highlight .mb { color: #208050 } /* Literal.Number.Bin */
46 | .highlight .mf { color: #208050 } /* Literal.Number.Float */
47 | .highlight .mh { color: #208050 } /* Literal.Number.Hex */
48 | .highlight .mi { color: #208050 } /* Literal.Number.Integer */
49 | .highlight .mo { color: #208050 } /* Literal.Number.Oct */
50 | .highlight .sa { color: #4070a0 } /* Literal.String.Affix */
51 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
52 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */
53 | .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
54 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
55 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */
56 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
57 | .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
58 | .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
59 | .highlight .sx { color: #c65d09 } /* Literal.String.Other */
60 | .highlight .sr { color: #235388 } /* Literal.String.Regex */
61 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */
62 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */
63 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
64 | .highlight .fm { color: #06287e } /* Name.Function.Magic */
65 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
66 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
67 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
68 | .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
69 | .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */


--------------------------------------------------------------------------------
/docs/_static/pyramid.css:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * pyramid.css_t
  3 |  * ~~~~~~~~~~~~
  4 |  *
  5 |  * Sphinx stylesheet -- pylons theme.
  6 |  *
  7 |  * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
  8 |  * :license: BSD, see LICENSE for details.
  9 |  *
 10 |  */
 11 |  
 12 | @import url("basic.css");
 13 |  
 14 | /* -- page layout ----------------------------------------------------------- */
 15 |  
 16 | body {
 17 |     font-family: "Nobile", sans-serif;
 18 |     font-size: 100%;
 19 |     background-color: #393939;
 20 |     color: #ffffff;
 21 |     margin: 0;
 22 |     padding: 0;
 23 | }
 24 | 
 25 | div.documentwrapper {
 26 |     float: left;
 27 |     width: 100%;
 28 | }
 29 | 
 30 | div.bodywrapper {
 31 |     margin: 0 0 0 230px;
 32 | }
 33 | 
 34 | hr {
 35 |     border: 1px solid #B1B4B6;
 36 | }
 37 |  
 38 | div.document {
 39 |     background-color: #eee;
 40 | }
 41 | 
 42 | div.header {
 43 |     width:100%;
 44 |     background: #f4ad32 url(headerbg.png) repeat-x 0 top;
 45 |     border-bottom: 2px solid #ffffff;
 46 | }
 47 | 
 48 | div.logo {
 49 |     text-align: center;
 50 |     padding-top: 10px;
 51 | }
 52 | 
 53 | div.body {
 54 |     background-color: #ffffff;
 55 |     color: #3E4349;
 56 |     padding: 0 30px 30px 30px;
 57 |     font-size: 1em;
 58 |     border: 2px solid #ddd;
 59 |     border-right-style: none;
 60 |     overflow: auto;
 61 | }
 62 |  
 63 | div.footer {
 64 |     color: #ffffff;
 65 |     width: 100%;
 66 |     padding: 13px 0;
 67 |     text-align: center;
 68 |     font-size: 75%;
 69 |     background: transparent;
 70 |     clear:both;
 71 | }
 72 |  
 73 | div.footer a {
 74 |     color: #ffffff;
 75 |     text-decoration: none;
 76 | }
 77 | 
 78 | div.footer a:hover {
 79 |     color: #e88f00;
 80 |     text-decoration: underline;
 81 | }
 82 |  
 83 | div.related {
 84 |     line-height: 30px;
 85 |     color: #373839;
 86 |     font-size: 0.8em;
 87 |     background-color: #eee;
 88 | }
 89 |  
 90 | div.related a {
 91 |     color: #1b61d6;
 92 | }
 93 | 
 94 | div.related ul {
 95 |     padding-left: calc(230px + 10px);
 96 | }
 97 |  
 98 | div.sphinxsidebar {
 99 |     font-size: 0.75em;
100 |     line-height: 1.5em;
101 | }
102 | 
103 | div.sphinxsidebarwrapper{
104 |     padding: 10px 0;
105 | }
106 |  
107 | div.sphinxsidebar h3,
108 | div.sphinxsidebar h4 {
109 |     font-family: "Neuton", sans-serif;
110 |     color: #373839;
111 |     font-size: 1.4em;
112 |     font-weight: normal;
113 |     margin: 0;
114 |     padding: 5px 10px;
115 |     border-bottom: 2px solid #ddd;
116 | }
117 | 
118 | div.sphinxsidebar h4{
119 |     font-size: 1.3em;
120 | }
121 |  
122 | div.sphinxsidebar h3 a {
123 |     color: #000000;
124 | }
125 |  
126 |  
127 | div.sphinxsidebar p {
128 |     color: #888;
129 |     padding: 5px 20px;
130 | }
131 |  
132 | div.sphinxsidebar p.topless {
133 | }
134 |  
135 | div.sphinxsidebar ul {
136 |     margin: 10px 20px;
137 |     padding: 0;
138 |     color: #373839;
139 | }
140 |  
141 | div.sphinxsidebar a {
142 |     color: #444;
143 | }
144 |  
145 | div.sphinxsidebar input {
146 |     border: 1px solid #ccc;
147 |     font-family: sans-serif;
148 |     font-size: 1em;
149 | }
150 | 
151 | div.sphinxsidebar .searchformwrapper {
152 |     margin-left: 20px;
153 |     margin-right: 20px;
154 | }
155 | 
156 | /* -- sidebars -------------------------------------------------------------- */
157 | 
158 | div.sidebar {
159 |     margin: 0 0 0.5em 1em;
160 |     border: 2px solid #c6d880;
161 |     background-color: #e6efc2;
162 |     width: 40%;
163 |     float: right;
164 |     border-right-style: none;
165 |     border-left-style: none;
166 |     padding: 10px 20px;
167 | }
168 | 
169 | p.sidebar-title {
170 |     font-weight: bold;
171 | }
172 | 
173 | /* -- body styles ----------------------------------------------------------- */
174 |  
175 | a, a .pre {
176 |     color: #1b61d6;
177 |     text-decoration: none;
178 | }
179 |  
180 | a:hover, a:hover .pre {
181 |     text-decoration: underline;
182 | }
183 |  
184 | div.body h1,
185 | div.body h2,
186 | div.body h3,
187 | div.body h4,
188 | div.body h5,
189 | div.body h6 {
190 |     font-family: "Neuton", sans-serif;
191 |     background-color: #ffffff;
192 |     font-weight: normal;
193 |     color: #373839;
194 |     margin: 30px 0px 10px 0px;
195 |     padding: 5px 0;
196 | }
197 |  
198 | div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; }
199 | div.body h2 { font-size: 150%; background-color: #ffffff; }
200 | div.body h3 { font-size: 120%; background-color: #ffffff; }
201 | div.body h4 { font-size: 110%; background-color: #ffffff; }
202 | div.body h5 { font-size: 100%; background-color: #ffffff; }
203 | div.body h6 { font-size: 100%; background-color: #ffffff; }
204 |  
205 | a.headerlink {
206 |     color: #1b61d6;
207 |     font-size: 0.8em;
208 |     padding: 0 4px 0 4px;
209 |     text-decoration: none;
210 | }
211 |  
212 | a.headerlink:hover {
213 |     text-decoration: underline;
214 | }
215 |  
216 | div.body p, div.body dd, div.body li {
217 |     line-height: 1.5em;
218 | }
219 |  
220 | div.admonition p.admonition-title + p {
221 |     display: inline;
222 | }
223 | 
224 | div.admonition {
225 |     background: #eeeeec;
226 |     border: 2px solid #babdb6;
227 |     border-right-style: none;
228 |     border-left-style: none;
229 |     padding: 10px 20px 10px 60px;
230 | }
231 | 
232 | div.highlight{
233 |     background-color: white;
234 | }
235 | 
236 | div.note {
237 |     border: 2px solid #7a9eec;
238 |     border-right-style: none;
239 |     border-left-style: none;
240 |     padding: 10px 20px 10px 60px;
241 |     background: #e1ecfe url(dialog-note.png) no-repeat 10px 8px;
242 | }
243 |  
244 | div.seealso {
245 |     background: #fff6bf url(dialog-seealso.png) no-repeat 10px 8px;
246 |     border: 2px solid #ffd324;
247 |     border-left-style: none;
248 |     border-right-style: none;
249 |     padding: 10px 20px 10px 60px;
250 | }
251 |  
252 | div.topic {
253 |     background: #eeeeee;
254 |     border: 2px solid #C6C9CB;
255 |     padding: 10px 20px;
256 |     border-right-style: none;
257 |     border-left-style: none;
258 | }
259 |  
260 | div.warning {
261 |     background: #fbe3e4 url(dialog-warning.png) no-repeat 10px 8px;
262 |     border: 2px solid #fbc2c4;
263 |     border-right-style: none;
264 |     border-left-style: none;
265 |     padding: 10px 20px 10px 60px;
266 | }
267 | 
268 | div.admonition-todo {
269 |     background: #f2d9b4 url(dialog-todo.png) no-repeat 10px 8px;
270 |     border: 2px solid #e9b96e;
271 |     border-right-style: none;
272 |     border-left-style: none;
273 |     padding: 10px 20px 10px 60px;
274 | }
275 |  
276 | div.note p.admonition-title,
277 | div.warning p.admonition-title,
278 | div.seealso p.admonition-title,
279 | div.admonition-todo p.admonition-title {
280 |     display: none;
281 | }
282 |  
283 | p.admonition-title:after {
284 |     content: ":";
285 | }
286 |  
287 | pre {
288 |     padding: 10px;
289 |     background-color: #fafafa;
290 |     color: #222;
291 |     line-height: 1.2em;
292 |     border: 2px solid #C6C9CB;
293 |     font-size: 1.1em;
294 |     margin: 1.5em 0 1.5em 0;
295 |     border-right-style: none;
296 |     border-left-style: none;
297 | }
298 |  
299 | code {
300 |     background-color: transparent;
301 |     color: #222;
302 |     font-size: 1.1em;
303 |     font-family: monospace;
304 | }
305 | 
306 | .viewcode-back {
307 |     font-family: "Nobile", sans-serif;
308 | }
309 | 
310 | div.viewcode-block:target {
311 |     background-color: #fff6bf;
312 |     border: 2px solid #ffd324;
313 |     border-left-style: none;
314 |     border-right-style: none;
315 |     padding: 10px 20px;
316 | }
317 | 
318 | table.highlighttable {
319 |     width: 100%;
320 | }
321 | 
322 | table.highlighttable td {
323 |     padding: 0;
324 | }
325 | 
326 | a em.std-term {
327 |    color: #007f00;
328 | }
329 | 
330 | a:hover em.std-term {
331 |     text-decoration: underline;
332 | }
333 | 
334 | .download {
335 |     font-family: "Nobile", sans-serif;
336 |     font-weight: normal;
337 |     font-style: normal;
338 | }
339 | 
340 | code.xref {
341 |     font-weight: normal;
342 |     font-style: normal;
343 | }
344 | 
345 | div.code-block-caption {
346 |     background-color: #ddd;
347 |     color: #222;
348 | }


--------------------------------------------------------------------------------
/docs/_static/transparent.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/transparent.gif


--------------------------------------------------------------------------------
/docs/_static/up-pressed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/up-pressed.png


--------------------------------------------------------------------------------
/docs/_static/up.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/_static/up.png


--------------------------------------------------------------------------------
/docs/objects.inv:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/docs/objects.inv


--------------------------------------------------------------------------------
/docs/search.html:
--------------------------------------------------------------------------------
 1 | 
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 3 |   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 4 | 
 5 | <html xmlns="http://www.w3.org/1999/xhtml">
 6 |   <head>
 7 |     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
 8 |     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 9 |     <title>Search &#8212; QGIS Plugin Builder 3.0.x documentation</title>
10 |     <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
11 |     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12 |     
13 |     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
14 |     <script type="text/javascript" src="_static/jquery.js"></script>
15 |     <script type="text/javascript" src="_static/underscore.js"></script>
16 |     <script type="text/javascript" src="_static/doctools.js"></script>
17 |     <script type="text/javascript" src="_static/language_data.js"></script>
18 |     <script type="text/javascript" src="_static/searchtools.js"></script>
19 |     <link rel="index" title="Index" href="genindex.html" />
20 |     <link rel="search" title="Search" href="#" />
21 |   <script type="text/javascript">
22 |     jQuery(function() { Search.loadIndex("searchindex.js"); });
23 |   </script>
24 |   
25 |   <script type="text/javascript" id="searchindexloader"></script>
26 |   
27 | <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
28 | <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
29 | <!--[if lte IE 6]>
30 | <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
31 | <![endif]-->
32 | 
33 | 
34 |   </head><body>
35 | 
36 |     <div class="related" role="navigation" aria-label="related navigation">
37 |       <h3>Navigation</h3>
38 |       <ul>
39 |         <li class="right" style="margin-right: 10px">
40 |           <a href="genindex.html" title="General Index"
41 |              accesskey="I">index</a></li>
42 |         <li class="nav-item nav-item-0"><a href="index.html">QGIS Plugin Builder 3.0.x documentation</a> &#187;</li> 
43 |       </ul>
44 |     </div>  
45 | 
46 |     <div class="document">
47 |       <div class="documentwrapper">
48 |         <div class="bodywrapper">
49 |           <div class="body" role="main">
50 |             
51 |   <h1 id="search-documentation">Search</h1>
52 |   <div id="fallback" class="admonition warning">
53 |   <script type="text/javascript">$('#fallback').hide();</script>
54 |   <p>
55 |     Please activate JavaScript to enable the search
56 |     functionality.
57 |   </p>
58 |   </div>
59 |   <p>
60 |     From here you can search these documents. Enter your search
61 |     words into the box below and click "search". Note that the search
62 |     function will automatically search for all of the words. Pages
63 |     containing fewer words won't appear in the result list.
64 |   </p>
65 |   <form action="" method="get">
66 |     <input type="text" name="q" value="" />
67 |     <input type="submit" value="search" />
68 |     <span id="search-progress" style="padding-left: 10px"></span>
69 |   </form>
70 |   
71 |   <div id="search-results">
72 |   
73 |   </div>
74 | 
75 |           </div>
76 |         </div>
77 |       </div>
78 |       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
79 |         <div class="sphinxsidebarwrapper">
80 |         </div>
81 |       </div>
82 |       <div class="clearer"></div>
83 |     </div>
84 |     <div class="related" role="navigation" aria-label="related navigation">
85 |       <h3>Navigation</h3>
86 |       <ul>
87 |         <li class="right" style="margin-right: 10px">
88 |           <a href="genindex.html" title="General Index"
89 |              >index</a></li>
90 |         <li class="nav-item nav-item-0"><a href="index.html">QGIS Plugin Builder 3.0.x documentation</a> &#187;</li> 
91 |       </ul>
92 |     </div>
93 |     <div class="footer" role="contentinfo">
94 |         &#169; Copyright 2011-2019, Gary Sherman.
95 |       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
96 |     </div>
97 |   </body>
98 | </html>


--------------------------------------------------------------------------------
/docs/searchindex.js:
--------------------------------------------------------------------------------
1 | Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"class":0,"default":0,"function":0,"import":0,"long":0,"new":0,"return":0,"short":0,"throw":0,For:0,Then:0,There:0,Use:0,With:0,accept:0,accordingli:0,action:0,actual:0,add:0,added:0,adding:0,address:0,after:0,aid:0,all:0,allow:0,also:0,although:0,ani:0,anyth:0,appdata:0,appear:0,appli:0,applic:0,appropri:0,approv:0,archiv:0,arg:0,assum:0,attempt:0,author:0,automat:0,avail:0,avoid:0,base:0,basic:0,befor:0,being:0,below:0,benefit:0,best:0,bleed:0,both:0,box:0,browser:0,bug:0,build:0,built:0,button:0,camelcas:0,can:0,categori:0,caus:0,cfg:0,chang:0,check:0,choic:0,choos:0,clean:0,clean_doc:0,click:0,code:0,com:0,come:0,comma:0,command:0,commun:0,compani:0,complet:0,compos:0,config:0,configur:0,connect:0,consequ:0,consid:0,contact:0,contain:0,content:0,control:0,copyright:0,cours:0,coverag:0,creat:0,csv:0,current:0,custom:0,databas:0,dclean:0,declar:0,definit:0,delet:0,deras:0,describ:0,descript:0,design:0,detail:0,detect:0,detect_featur:0,detector:0,determin:0,develop:0,dialog:0,differ:0,directori:0,disappear:0,displai:0,distribut:0,doc:0,dock:0,download:0,dure:0,each:0,easili:0,easy_instal:0,edg:0,edit:0,either:0,email:0,enabl:0,ensur:0,enter:0,entir:0,entri:0,epub:0,error:0,etc:0,exampl:0,exist:0,exit:0,experiment:0,fail:0,fairli:0,fashion:0,field:0,fill:0,filter:0,follow:0,format:0,found:0,frog:0,from:0,full:0,genrat:0,get:0,git:0,github:0,give:0,gmake:0,gnu:0,greater:0,grei:0,group:0,guess:0,handi:0,have:0,header:0,help:0,helper:0,here:0,hint:0,home:0,hover:0,html:0,http:0,hub:0,icon:0,identifi:0,improv:0,includ:0,incomplet:0,increment:0,index:0,insid:0,instead:0,interfac:0,internation:0,isn:0,issu:0,item:0,its:0,just:0,keep:0,keyword:0,latest:0,latex:0,librari:0,like:0,line:0,linux:0,list:0,live:0,load:0,local:0,locat:0,look:0,lower:0,lowercas:0,lreleas:0,mac:0,mai:0,main:0,make:0,manag:0,mandatori:0,manual:0,mean:0,media:0,menu:0,messag:0,metadata:0,minimum:0,modul:0,more:0,most:0,must:0,myplugin:0,need:0,newer:0,next:0,none:0,number:0,older:0,onc:0,one:0,onli:0,open:0,oper:0,option:0,order:0,org:0,other:0,out:0,over:0,own:0,packag:0,page:0,part:0,patch:0,path:0,pep8:0,per:0,pip:0,place:0,plain:0,platform:0,plugin_build_tool:0,plugin_tag:0,pluginbuild:0,png:0,point:0,pond:0,present:0,prevent:0,problem:0,process:0,produc:0,profil:0,project:0,proper:0,properli:0,provid:0,publish:0,purpos:0,put:0,pylint:0,pyqt:0,pyrcc5:0,python:0,qgis2:0,qgis3:0,qgis_pluginpath:0,qgisdir:0,qrc:0,qthelp:0,raster:0,rather:0,readabl:0,readi:0,readm:0,recommend:0,releas:0,remov:0,report:0,right:0,roam:0,rst:0,same:0,save:0,script:0,scriptrunn:0,search:0,section:0,see:0,select:0,separ:0,serious:0,set:0,sever:0,share:0,sherman:0,should:0,shouldn:0,show:0,shown:0,similar:0,simpl:0,simpli:0,sinc:0,singl:0,site:0,some:0,someth:0,sourc:0,space:0,spatialgalaxi:0,specifi:0,sphinx:0,standard:0,start:0,statement:0,step:0,store:0,strictli:0,strongli:0,stub:0,style:0,subdirectori:0,submit:0,success:0,suggest:0,suitabl:0,support:0,sure:0,svn:0,system:0,tag:0,target:0,tell:0,text:0,than:0,thei:0,thi:0,those:0,three:0,through:0,titl:0,tool:0,tooltip:0,track:0,tracker:0,transclean:0,transcompil:0,translat:0,transup:0,turn:0,tweak:0,two:0,txt:0,type:0,under:0,underscor:0,unintend:0,unit:0,updat:0,upgrad:0,upload:0,upon:0,url:0,use:0,used:0,useful:0,user:0,uses:0,using:0,util:0,valid:0,vector:0,version:0,view:0,violat:0,wai:0,want:0,web:0,websit:0,well:0,what:0,when:0,where:0,which:0,widget:0,window:0,within:0,without:0,word:0,work:0,write:0,written:0,yet:0,you:0,zip:0},titles:["QGIS Plugin Builder"],titleterms:{"public":0,The:0,Using:0,about:0,addit:0,builder:0,compil:0,compon:0,concept:0,copi:0,deploi:0,document:0,environ:0,featur:0,file:0,gener:0,inform:0,instal:0,makefil:0,method:0,name:0,paramet:0,pb_tool:0,plugin:0,qgi:0,repositori:0,requir:0,resourc:0,result:0,run:0,specif:0,templat:0,test:0,usag:0,variabl:0,your:0}})


--------------------------------------------------------------------------------
/help/Makefile:
--------------------------------------------------------------------------------
  1 | # Makefile for Sphinx documentation
  2 | #
  3 | default: html
  4 | 
  5 | # You can set these variables from the command line.
  6 | SPHINXOPTS    =
  7 | SPHINXBUILD   = sphinx-build
  8 | PAPER         =
  9 | BUILDDIR      = ../docs
 10 | 
 11 | # Internal variables.
 12 | PAPEROPT_a4     = -D latex_paper_size=a4
 13 | PAPEROPT_letter = -D latex_paper_size=letter
 14 | ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 15 | # the i18n builder cannot share the environment and doctrees with the others
 16 | I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 17 | 
 18 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 19 | 
 20 | help:
 21 | 	@echo "Please use \`make <target>' where <target> is one of"
 22 | 	@echo "  html       to make standalone HTML files"
 23 | 	@echo "  dirhtml    to make HTML files named index.html in directories"
 24 | 	@echo "  singlehtml to make a single large HTML file"
 25 | 	@echo "  pickle     to make pickle files"
 26 | 	@echo "  json       to make JSON files"
 27 | 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 28 | 	@echo "  qthelp     to make HTML files and a qthelp project"
 29 | 	@echo "  devhelp    to make HTML files and a Devhelp project"
 30 | 	@echo "  epub       to make an epub"
 31 | 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 32 | 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 33 | 	@echo "  text       to make text files"
 34 | 	@echo "  man        to make manual pages"
 35 | 	@echo "  texinfo    to make Texinfo files"
 36 | 	@echo "  info       to make Texinfo files and run them through makeinfo"
 37 | 	@echo "  gettext    to make PO message catalogs"
 38 | 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 39 | 	@echo "  linkcheck  to check all external links for integrity"
 40 | 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 41 | 
 42 | clean:
 43 | 	-rm -rf $(BUILDDIR)/*
 44 | 
 45 | html:
 46 | 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
 47 | 	@echo
 48 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)"
 49 | 
 50 | dirhtml:
 51 | 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 52 | 	@echo
 53 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 54 | 
 55 | singlehtml:
 56 | 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 57 | 	@echo
 58 | 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 59 | 
 60 | pickle:
 61 | 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 62 | 	@echo
 63 | 	@echo "Build finished; now you can process the pickle files."
 64 | 
 65 | json:
 66 | 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 67 | 	@echo
 68 | 	@echo "Build finished; now you can process the JSON files."
 69 | 
 70 | htmlhelp:
 71 | 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 72 | 	@echo
 73 | 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 74 | 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 75 | 
 76 | qthelp:
 77 | 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 78 | 	@echo
 79 | 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 80 | 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 81 | 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/QGISPluginBuilder.qhcp"
 82 | 	@echo "To view the help file:"
 83 | 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/QGISPluginBuilder.qhc"
 84 | 
 85 | devhelp:
 86 | 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 87 | 	@echo
 88 | 	@echo "Build finished."
 89 | 	@echo "To view the help file:"
 90 | 	@echo "# mkdir -p $$HOME/.local/share/devhelp/QGISPluginBuilder"
 91 | 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/QGISPluginBuilder"
 92 | 	@echo "# devhelp"
 93 | 
 94 | epub:
 95 | 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 96 | 	@echo
 97 | 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 98 | 
 99 | latex:
100 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
101 | 	@echo
102 | 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
103 | 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
104 | 	      "(use \`make latexpdf' here to do that automatically)."
105 | 
106 | latexpdf:
107 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108 | 	@echo "Running LaTeX files through pdflatex..."
109 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
110 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
111 | 
112 | text:
113 | 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
114 | 	@echo
115 | 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
116 | 
117 | man:
118 | 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
119 | 	@echo
120 | 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
121 | 
122 | texinfo:
123 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
124 | 	@echo
125 | 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
126 | 	@echo "Run \`make' in that directory to run these through makeinfo" \
127 | 	      "(use \`make info' here to do that automatically)."
128 | 
129 | info:
130 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
131 | 	@echo "Running Texinfo files through makeinfo..."
132 | 	make -C $(BUILDDIR)/texinfo info
133 | 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
134 | 
135 | gettext:
136 | 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
137 | 	@echo
138 | 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
139 | 
140 | changes:
141 | 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
142 | 	@echo
143 | 	@echo "The overview file is in $(BUILDDIR)/changes."
144 | 
145 | linkcheck:
146 | 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
147 | 	@echo
148 | 	@echo "Link check complete; look for any errors in the above output " \
149 | 	      "or in $(BUILDDIR)/linkcheck/output.txt."
150 | 
151 | doctest:
152 | 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
153 | 	@echo "Testing of doctests in the sources finished, look at the " \
154 | 	      "results in $(BUILDDIR)/doctest/output.txt."
155 | 


--------------------------------------------------------------------------------
/help/source/images/compile_failed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/compile_failed.png


--------------------------------------------------------------------------------
/help/source/images/generating.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/generating.png


--------------------------------------------------------------------------------
/help/source/images/plugin_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/plugin_menu.png


--------------------------------------------------------------------------------
/help/source/images/plugin_results.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/plugin_results.png


--------------------------------------------------------------------------------
/help/source/images/plugin_test.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/plugin_test.png


--------------------------------------------------------------------------------
/help/source/images/redundant_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/redundant_menu.png


--------------------------------------------------------------------------------
/help/source/images/wizard_about.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/wizard_about.png


--------------------------------------------------------------------------------
/help/source/images/wizard_helpers.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/wizard_helpers.png


--------------------------------------------------------------------------------
/help/source/images/wizard_publication_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/wizard_publication_info.png


--------------------------------------------------------------------------------
/help/source/images/wizard_required_info.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/wizard_required_info.png


--------------------------------------------------------------------------------
/help/source/images/wizard_template.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/help/source/images/wizard_template.png


--------------------------------------------------------------------------------
/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/icon.png


--------------------------------------------------------------------------------
/icon.readme:
--------------------------------------------------------------------------------
1 | Icon adapted from noun project under the following license
2 | Creative Commons – Attribution (CC BY 3.0)
3 | Hammer designed by Mourad Mokrane from the Noun Project
4 | 
5 | git sha : $Format:%H$
6 | 


--------------------------------------------------------------------------------
/icon.svg:
--------------------------------------------------------------------------------
1 | Oxygen480-categories-applications-development.svg


--------------------------------------------------------------------------------
/icon.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/icon.xcf


--------------------------------------------------------------------------------
/metadata.txt:
--------------------------------------------------------------------------------
 1 | # This file contains metadata for your plugin. Beginning
 2 | # with version 1.8 this is the preferred way to supply information about a
 3 | # plugin. The current method of embedding metadata in __init__.py will
 4 | # be supported until version 2.0
 5 | # git sha : $Format:%H$
 6 | # This file should be included when you package your plugin.
 7 | 
 8 | [general]
 9 | name=Plugin Builder 3
10 | about=Create a template for a QGIS plugin
11 | description=Creates a QGIS plugin template for use as a starting point in plugin development
12 | version=3.2.1
13 | qgisMinimumVersion=2.99
14 | qgisMaximumVersion=3.99
15 | 
16 | changelog=3.2.1 2019-06-28
17 |       * Bug fixes
18 |     3.1 2018-12-31
19 |       * Fix issue with reload on generated plugins
20 |     3.0.5 2018-12-31:
21 |       * Fix issue with reload on generated plugins
22 |     3.0.4 2018-12-25:
23 |       * Move dialog creation to run method.
24 |       * Move help file generation files to proper method
25 |       * Include missing tags file
26 |       * Attempt to compile resources.qrc when plugin is generated (requires pyrcc5 in path)
27 |       * Set deployment directory in Makefile based on user OS (pb_tool is preferred over make)
28 |       * Check for valid URL format for tracker and repository
29 |     3.0.3 2018-02-23: Redesign of UI to allow better editing prior to generation.
30 | 
31 | homepage=http://g-sherman.github.io/Qgis-Plugin-Builder
32 | tracker=https://github.com/g-sherman/Qgis-Plugin-Builder/issues
33 | repository=https://github.com/g-sherman/Qgis-Plugin-Builder
34 | tags=development
35 | icon=icon.png
36 | 
37 | experimental=False
38 | deprecated=False
39 | 
40 | author=GeoApt LLC
41 | email=gsherman@geoapt.com
42 | 


--------------------------------------------------------------------------------
/pb_tool.cfg:
--------------------------------------------------------------------------------
 1 | # Configuration file for plugin builder tool
 2 | # Sane defaults for your plugin generated by the Plugin Builder are
 3 | # already set below.
 4 | #
 5 | # As you add Python source files and UI files to your plugin, add
 6 | # them to the appropriate [files] section below.
 7 | 
 8 | [plugin]
 9 | # Name of the plugin. This is the name of the directory that will
10 | # be created when deployed
11 | name: pluginbuilder3
12 | 
13 | # Full path to where you want your plugin directory copied. If empty,
14 | # the QGIS default path will be used. Don't include the plugin name in
15 | # the path.
16 | plugin_path:
17 | 
18 | [files]
19 | # Python  files that should be deployed with the plugin
20 | python_files: __init__.py plugin_builder.py plugin_builder_dialog.py  plugin_specification.py resources.py result_dialog.py  select_tags_dialog.py qgis_dirs.py
21 | 
22 | # The main dialog file that is loaded (not compiled)
23 | main_dialog: plugin_builder_dialog_base.ui results_dialog_base.ui select_tags_dialog_base.ui
24 | 
25 | # Other ui files for your dialogs (these will be compiled)
26 | compiled_ui_files: 
27 | 
28 | # Resource file(s) that will be compiled
29 | resource_files: resources.qrc
30 | 
31 | # Other files required for the plugin
32 | extras: icon.png plugin_builder.png metadata.txt taglist.txt
33 | 
34 | # Other directories to be deployed with the plugin.
35 | # These must be subdirectories under the plugin directory
36 | extra_dirs: plugin_templates
37 | 
38 | # ISO code(s) for any locales (translations), separated by spaces.
39 | # Corresponding .ts files must exist in the i18n directory
40 | locales: 
41 | 
42 | [help]
43 | # the built help directory that should be deployed with the plugin
44 | dir: docs
45 | # the name of the directory to target in the deployed plugin
46 | target: help
47 | 


--------------------------------------------------------------------------------
/plugin_builder.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/plugin_builder.png


--------------------------------------------------------------------------------
/plugin_specification.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """
 3 | /***************************************************************************
 4 |     PluginSpec
 5 | 
 6 |     Creates a skeleton QGIS plugin for use as a starting point
 7 |                              -------------------
 8 |         begin                : 2011-01-20
 9 |         git sha              : $Format:%H$
10 |         copyright            : (C) 2011-2014 by GeoApt LLC
11 |         email                : gsherman@geoapt.com
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 | """
23 | import datetime
24 | 
25 | 
26 | class PluginSpecification:
27 |     """A convenience store with information needed to create the plugin."""
28 |     def __init__(self, dialog):
29 |         """Constructor.
30 | 
31 |         After calling the constructor, the class properties
32 |         self.template_map, self.experimental etc. will be set.
33 | 
34 |         :param dialog: A plugin builder dialog with populated options.
35 |         :type dialog: PluginBuilderDialog
36 | 
37 |         """
38 |         self.class_name = str(dialog.class_name.text())
39 |         self.author = dialog.author.text()
40 |         self.description = dialog.description.text()
41 |         self.module_name = dialog.module_name.text()
42 |         self.email_address = dialog.email_address.text()
43 |         self.qgis_minimum_version = dialog.qgis_minimum_version.text()
44 |         self.title = dialog.title.text()
45 |         self.plugin_version = dialog.plugin_version.text()
46 | 
47 |         # remove multiple newlines/spaces from about text
48 |         about = dialog.about.toPlainText().replace('\n', ' ')
49 |         self.about = ' '.join(about.split())
50 | 
51 |         self.homepage = dialog.homepage.text()
52 |         self.tracker = dialog.tracker.text()
53 |         self.repository = dialog.repository.text()
54 |         self.tags = dialog.tags.text()
55 |         # icon selection from disk will be added at a later version
56 |         self.icon = 'icon.png'
57 |         self.experimental = dialog.experimental.isChecked()
58 |         # deprecated is always false for a new plugin
59 |         self.deprecated = False
60 |         # Builder flags
61 |         self.gen_i18n = dialog.i18n_cb.isChecked()
62 |         self.gen_help = dialog.help_cb.isChecked()
63 |         self.gen_tests = dialog.tests_cb.isChecked()
64 |         self.gen_scripts = dialog.scripts_cb.isChecked()
65 |         self.gen_makefile = dialog.makefile_cb.isChecked()
66 |         self.gen_pb_tool = dialog.pb_tool_cb.isChecked()
67 |         # Add the date stuff to the template map
68 |         now = datetime.date.today()
69 |         self.build_year = now.year
70 |         self.build_date = '%i-%02i-%02i' % (now.year, now.month, now.day)
71 |         # Git will replace this with the sha - I do it a funny way below so
72 |         # that this line below does not itself get substituted by git!
73 |         self.vcs_format = '$Format:' + '%H$'
74 |         self.template_map = {
75 |             'TemplateClass': self.class_name,
76 |             'TemplateTitle': self.title,
77 |             'TemplateDescription': self.description,
78 |             'TemplateModuleName': self.module_name,
79 |             'TemplateVersion': self.plugin_version,
80 |             'TemplateQgisVersion': self.qgis_minimum_version,
81 |             'TemplateAuthor': self.author,
82 |             'TemplateEmail': self.email_address,
83 |             'PluginDirectoryName': self.class_name.lower(),
84 |             'TemplateBuildDate': self.build_date,
85 |             'TemplateYear': self.build_year,
86 |             'TemplateVCSFormat': self.vcs_format,
87 |             # Makefile defaults
88 |             'TemplatePyFiles': '',
89 |             'TemplateUiFiles': '',
90 |             'TemplateExtraFiles': '',
91 |             'TemplateQrcFiles': '',
92 |             'TemplateRcFiles': ''
93 |         }
94 | 


--------------------------------------------------------------------------------
/plugin_templates/__init__.py:
--------------------------------------------------------------------------------
 1 | def templates():
 2 |     from .toolbutton_with_dialog.plugin_template import ToolbuttonWithDialogPluginTemplate
 3 |     from .toolbutton_with_dockwidget.plugin_template import ToolbuttonWithDockWidgetPluginTemplate
 4 |     from .processing_provider.plugin_template import ProcessingProviderPluginTemplate
 5 |     return [
 6 |         ToolbuttonWithDialogPluginTemplate(),
 7 |         ToolbuttonWithDockWidgetPluginTemplate(),
 8 |         ProcessingProviderPluginTemplate()
 9 |     ]
10 | 


--------------------------------------------------------------------------------
/plugin_templates/plugin_template.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  PluginTemplate
 5 |                                  A QGIS plugin
 6 |  plugin_template
 7 |                               -------------------
 8 |         begin                : 2015-03-17
 9 |         git sha              : $Format:%H$
10 |         copyright            : (C) 2015 by Pirmin Kalberer
11 |         email                : pka@sourcepole.ch
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 | """
23 | 
24 | 
25 | class PluginTemplate:
26 |     """Base class for plugin templates."""
27 | 
28 |     def descr(self):
29 |         raise NotImplementedError
30 | 
31 |     def subdir(self):
32 |         raise NotImplementedError
33 | 
34 |     def template_map(self, specification, dialog):
35 |         return {}
36 | 
37 |     def template_files(self, specification):
38 |         return {}
39 | 
40 |     def copy_files(self, specification):
41 |         return {}
42 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/plugin_templates/processing_provider/__init__.py


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/plugin_template.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  PluginTemplate
 5 |                                  A QGIS plugin
 6 |  plugin_template
 7 |                               -------------------
 8 |         begin                : 2015-03-17
 9 |         git sha              : $Format:%H$
10 |         copyright            : (C) 2015 by Pirmin Kalberer
11 |         email                : pka@sourcepole.ch
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 | """
23 | 
24 | import os
25 | from ..plugin_template import PluginTemplate
26 | from ...qgis_dirs import deployment_dir
27 | 
28 | 
29 | class ProcessingProviderPluginTemplate(PluginTemplate):
30 | 
31 |     def descr(self):
32 |         return "Processing Provider"
33 | 
34 |     def subdir(self):
35 |         return os.path.dirname(__file__)
36 | 
37 |     def template_map(self, specification, dialog):
38 |         self.category = 'Analysis'
39 |         frame = dialog.template_subframe
40 |         return {
41 |             # Makefile
42 |             'TemplateQGISDir': deployment_dir,
43 |             # Metadata
44 |             'TemplateHasProcessingProvider': True,
45 |             # Processing
46 |             'TemplateAlgoName': frame.algo_name_text.text(),
47 |             'TemplateAlgoGroup': frame.algo_group_text.text(),
48 |             'TemplateProviderName': frame.provider_name_text.text(),
49 |             'TemplateProviderDescr': frame.provider_descr_text.text()
50 |         }
51 | 
52 |     def template_files(self, specification):
53 |         return {
54 |             'module_name_algorithm.tmpl':
55 |             '%s_algorithm.py' % specification.module_name,
56 |             'module_name_provider.tmpl':
57 |             '%s_provider.py' % specification.module_name,
58 |         }
59 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/template/__init__.tmpl:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  $TemplateClass
 5 |                                  A QGIS plugin
 6 |  $TemplateDescription
 7 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 8 |                               -------------------
 9 |         begin                : $TemplateBuildDate
10 |         copyright            : (C) $TemplateYear by $TemplateAuthor
11 |         email                : $TemplateEmail
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 |  This script initializes the plugin, making it known to QGIS.
23 | """
24 | 
25 | __author__ = '$TemplateAuthor'
26 | __date__ = '$TemplateBuildDate'
27 | __copyright__ = '(C) $TemplateYear by $TemplateAuthor'
28 | 
29 | 
30 | # noinspection PyPep8Naming
31 | def classFactory(iface):  # pylint: disable=invalid-name
32 |     """Load ${TemplateClass} class from file ${TemplateClass}.
33 | 
34 |     :param iface: A QGIS interface instance.
35 |     :type iface: QgsInterface
36 |     """
37 |     #
38 |     from .${TemplateModuleName} import ${TemplateClass}Plugin
39 |     return ${TemplateClass}Plugin()
40 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/template/module_name.tmpl:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | """
 4 | /***************************************************************************
 5 |  $TemplateClass
 6 |                                  A QGIS plugin
 7 |  $TemplateDescription
 8 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 9 |                               -------------------
10 |         begin                : $TemplateBuildDate
11 |         copyright            : (C) $TemplateYear by $TemplateAuthor
12 |         email                : $TemplateEmail
13 |  ***************************************************************************/
14 | 
15 | /***************************************************************************
16 |  *                                                                         *
17 |  *   This program is free software; you can redistribute it and/or modify  *
18 |  *   it under the terms of the GNU General Public License as published by  *
19 |  *   the Free Software Foundation; either version 2 of the License, or     *
20 |  *   (at your option) any later version.                                   *
21 |  *                                                                         *
22 |  ***************************************************************************/
23 | """
24 | 
25 | __author__ = '$TemplateAuthor'
26 | __date__ = '$TemplateBuildDate'
27 | __copyright__ = '(C) $TemplateYear by $TemplateAuthor'
28 | 
29 | # This will get replaced with a git SHA1 when you do a git archive
30 | 
31 | __revision__ = '$TemplateVCSFormat'
32 | 
33 | import os
34 | import sys
35 | import inspect
36 | 
37 | from qgis.core import QgsProcessingAlgorithm, QgsApplication
38 | from .${TemplateModuleName}_provider import ${TemplateClass}Provider
39 | 
40 | cmd_folder = os.path.split(inspect.getfile(inspect.currentframe()))[0]
41 | 
42 | if cmd_folder not in sys.path:
43 |     sys.path.insert(0, cmd_folder)
44 | 
45 | 
46 | class ${TemplateClass}Plugin(object):
47 | 
48 |     def __init__(self):
49 |         self.provider = None
50 | 
51 |     def initProcessing(self):
52 |         """Init Processing provider for QGIS >= 3.8."""
53 |         self.provider = ${TemplateClass}Provider()
54 |         QgsApplication.processingRegistry().addProvider(self.provider)
55 | 
56 |     def initGui(self):
57 |         self.initProcessing()
58 | 
59 |     def unload(self):
60 |         QgsApplication.processingRegistry().removeProvider(self.provider)
61 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/template/module_name_algorithm.tmpl:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | /***************************************************************************
  5 |  $TemplateClass
  6 |                                  A QGIS plugin
  7 |  $TemplateDescription
  8 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
  9 |                               -------------------
 10 |         begin                : $TemplateBuildDate
 11 |         copyright            : (C) $TemplateYear by $TemplateAuthor
 12 |         email                : $TemplateEmail
 13 |  ***************************************************************************/
 14 | 
 15 | /***************************************************************************
 16 |  *                                                                         *
 17 |  *   This program is free software; you can redistribute it and/or modify  *
 18 |  *   it under the terms of the GNU General Public License as published by  *
 19 |  *   the Free Software Foundation; either version 2 of the License, or     *
 20 |  *   (at your option) any later version.                                   *
 21 |  *                                                                         *
 22 |  ***************************************************************************/
 23 | """
 24 | 
 25 | __author__ = '$TemplateAuthor'
 26 | __date__ = '$TemplateBuildDate'
 27 | __copyright__ = '(C) $TemplateYear by $TemplateAuthor'
 28 | 
 29 | # This will get replaced with a git SHA1 when you do a git archive
 30 | 
 31 | __revision__ = '$TemplateVCSFormat'
 32 | 
 33 | from qgis.PyQt.QtCore import QCoreApplication
 34 | from qgis.core import (QgsProcessing,
 35 |                        QgsFeatureSink,
 36 |                        QgsProcessingAlgorithm,
 37 |                        QgsProcessingParameterFeatureSource,
 38 |                        QgsProcessingParameterFeatureSink)
 39 | 
 40 | 
 41 | class ${TemplateClass}Algorithm(QgsProcessingAlgorithm):
 42 |     """
 43 |     This is an example algorithm that takes a vector layer and
 44 |     creates a new identical one.
 45 | 
 46 |     It is meant to be used as an example of how to create your own
 47 |     algorithms and explain methods and variables used to do it. An
 48 |     algorithm like this will be available in all elements, and there
 49 |     is not need for additional work.
 50 | 
 51 |     All Processing algorithms should extend the QgsProcessingAlgorithm
 52 |     class.
 53 |     """
 54 | 
 55 |     # Constants used to refer to parameters and outputs. They will be
 56 |     # used when calling the algorithm from another algorithm, or when
 57 |     # calling from the QGIS console.
 58 | 
 59 |     OUTPUT = 'OUTPUT'
 60 |     INPUT = 'INPUT'
 61 | 
 62 |     def initAlgorithm(self, config):
 63 |         """
 64 |         Here we define the inputs and output of the algorithm, along
 65 |         with some other properties.
 66 |         """
 67 | 
 68 |         # We add the input vector features source. It can have any kind of
 69 |         # geometry.
 70 |         self.addParameter(
 71 |             QgsProcessingParameterFeatureSource(
 72 |                 self.INPUT,
 73 |                 self.tr('Input layer'),
 74 |                 [QgsProcessing.TypeVectorAnyGeometry]
 75 |             )
 76 |         )
 77 | 
 78 |         # We add a feature sink in which to store our processed features (this
 79 |         # usually takes the form of a newly created vector layer when the
 80 |         # algorithm is run in QGIS).
 81 |         self.addParameter(
 82 |             QgsProcessingParameterFeatureSink(
 83 |                 self.OUTPUT,
 84 |                 self.tr('Output layer')
 85 |             )
 86 |         )
 87 | 
 88 |     def processAlgorithm(self, parameters, context, feedback):
 89 |         """
 90 |         Here is where the processing itself takes place.
 91 |         """
 92 | 
 93 |         # Retrieve the feature source and sink. The 'dest_id' variable is used
 94 |         # to uniquely identify the feature sink, and must be included in the
 95 |         # dictionary returned by the processAlgorithm function.
 96 |         source = self.parameterAsSource(parameters, self.INPUT, context)
 97 |         (sink, dest_id) = self.parameterAsSink(parameters, self.OUTPUT,
 98 |                 context, source.fields(), source.wkbType(), source.sourceCrs())
 99 | 
100 |         # Compute the number of steps to display within the progress bar and
101 |         # get features from source
102 |         total = 100.0 / source.featureCount() if source.featureCount() else 0
103 |         features = source.getFeatures()
104 | 
105 |         for current, feature in enumerate(features):
106 |             # Stop the algorithm if cancel button has been clicked
107 |             if feedback.isCanceled():
108 |                 break
109 | 
110 |             # Add a feature in the sink
111 |             sink.addFeature(feature, QgsFeatureSink.FastInsert)
112 | 
113 |             # Update the progress bar
114 |             feedback.setProgress(int(current * total))
115 | 
116 |         # Return the results of the algorithm. In this case our only result is
117 |         # the feature sink which contains the processed features, but some
118 |         # algorithms may return multiple feature sinks, calculated numeric
119 |         # statistics, etc. These should all be included in the returned
120 |         # dictionary, with keys matching the feature corresponding parameter
121 |         # or output names.
122 |         return {self.OUTPUT: dest_id}
123 | 
124 |     def name(self):
125 |         """
126 |         Returns the algorithm name, used for identifying the algorithm. This
127 |         string should be fixed for the algorithm, and must not be localised.
128 |         The name should be unique within each provider. Names should contain
129 |         lowercase alphanumeric characters only and no spaces or other
130 |         formatting characters.
131 |         """
132 |         return '$TemplateAlgoName'
133 | 
134 |     def displayName(self):
135 |         """
136 |         Returns the translated algorithm name, which should be used for any
137 |         user-visible display of the algorithm name.
138 |         """
139 |         return self.tr(self.name())
140 | 
141 |     def group(self):
142 |         """
143 |         Returns the name of the group this algorithm belongs to. This string
144 |         should be localised.
145 |         """
146 |         return self.tr(self.groupId())
147 | 
148 |     def groupId(self):
149 |         """
150 |         Returns the unique ID of the group this algorithm belongs to. This
151 |         string should be fixed for the algorithm, and must not be localised.
152 |         The group id should be unique within each provider. Group id should
153 |         contain lowercase alphanumeric characters only and no spaces or other
154 |         formatting characters.
155 |         """
156 |         return '$TemplateAlgoGroup'
157 | 
158 |     def tr(self, string):
159 |         return QCoreApplication.translate('Processing', string)
160 | 
161 |     def createInstance(self):
162 |         return ${TemplateClass}Algorithm()
163 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/template/module_name_provider.tmpl:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | """
 4 | /***************************************************************************
 5 |  $TemplateClass
 6 |                                  A QGIS plugin
 7 |  $TemplateDescription
 8 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 9 |                               -------------------
10 |         begin                : $TemplateBuildDate
11 |         copyright            : (C) $TemplateYear by $TemplateAuthor
12 |         email                : $TemplateEmail
13 |  ***************************************************************************/
14 | 
15 | /***************************************************************************
16 |  *                                                                         *
17 |  *   This program is free software; you can redistribute it and/or modify  *
18 |  *   it under the terms of the GNU General Public License as published by  *
19 |  *   the Free Software Foundation; either version 2 of the License, or     *
20 |  *   (at your option) any later version.                                   *
21 |  *                                                                         *
22 |  ***************************************************************************/
23 | """
24 | 
25 | __author__ = '$TemplateAuthor'
26 | __date__ = '$TemplateBuildDate'
27 | __copyright__ = '(C) $TemplateYear by $TemplateAuthor'
28 | 
29 | # This will get replaced with a git SHA1 when you do a git archive
30 | 
31 | __revision__ = '$TemplateVCSFormat'
32 | 
33 | from qgis.core import QgsProcessingProvider
34 | from .${TemplateModuleName}_algorithm import ${TemplateClass}Algorithm
35 | 
36 | 
37 | class ${TemplateClass}Provider(QgsProcessingProvider):
38 | 
39 |     def __init__(self):
40 |         """
41 |         Default constructor.
42 |         """
43 |         QgsProcessingProvider.__init__(self)
44 | 
45 |     def unload(self):
46 |         """
47 |         Unloads the provider. Any tear-down steps required by the provider
48 |         should be implemented here.
49 |         """
50 |         pass
51 | 
52 |     def loadAlgorithms(self):
53 |         """
54 |         Loads all algorithms belonging to this provider.
55 |         """
56 |         self.addAlgorithm(${TemplateClass}Algorithm())
57 |         # add additional algorithms here
58 |         # self.addAlgorithm(MyOtherAlgorithm())
59 | 
60 |     def id(self):
61 |         """
62 |         Returns the unique provider id, used for identifying the provider. This
63 |         string should be a unique, short, character only string, eg "qgis" or
64 |         "gdal". This string should not be localised.
65 |         """
66 |         return '$TemplateProviderName'
67 | 
68 |     def name(self):
69 |         """
70 |         Returns the provider name, which is used to describe the provider
71 |         within the GUI.
72 | 
73 |         This string should be short (e.g. "Lastools") and localised.
74 |         """
75 |         return self.tr('$TemplateProviderName')
76 | 
77 |     def icon(self):
78 |         """
79 |         Should return a QIcon which is used for your provider inside
80 |         the Processing toolbox.
81 |         """
82 |         return QgsProcessingProvider.icon(self)
83 | 
84 |     def longName(self):
85 |         """
86 |         Returns the a longer version of the provider name, which can include
87 |         extra details such as version numbers. E.g. "Lastools LIDAR tools
88 |         (version 2.2.1)". This string should be localised. The default
89 |         implementation returns the same string as name().
90 |         """
91 |         return self.name()
92 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/template/readme.tmpl:
--------------------------------------------------------------------------------
 1 | Plugin Builder Results
 2 | 
 3 | Your plugin ${TemplateClass} was created in:
 4 |     ${PluginDir}
 5 | 
 6 | Your QGIS plugin directory is located at:
 7 |     ${UserPluginDir}
 8 | 
 9 | What's Next:
10 | 
11 |   * Copy the entire directory containing your new plugin to the QGIS plugin
12 |     directory
13 | 
14 |   * Run the tests (``make test``)
15 | 
16 |   * Test the plugin by enabling it in the QGIS plugin manager
17 | 
18 |   * Customize it by editing the implementation file: ``${TemplateModuleName}.py``
19 | 
20 |   * You can use the Makefile to compile your Ui and resource files when
21 |     you make changes. This requires GNU make (gmake)
22 | 
23 | For more information, see the PyQGIS Developer Cookbook at:
24 | http://www.qgis.org/pyqgis-cookbook/index.html
25 | 
26 | (C) 2011-2018 GeoApt LLC - geoapt.com
27 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/template/results.tmpl:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <body>
 3 | <h3>Plugin Builder Results</h3>
 4 | 
 5 | Congratulations! You just built a plugin for QGIS!<br/><br />
 6 | 
 7 | <div id='help' style='font-size:.9em;'>
 8 | Your plugin <b>${TemplateClass}</b> was created in:<br>
 9 | &nbsp;&nbsp;<b>${PluginDir}</b>
10 | <p>
11 | Your QGIS plugin directory is located at:<br>
12 | &nbsp;&nbsp;<b>${UserPluginDir}</b>
13 | <p>
14 | <h3>What's Next</h3>
15 | <ol>
16 |     <li>Test the generated sources using <b>make test</b> (or run tests from your IDE)
17 |     <li>Copy the entire directory containing your new plugin to the QGIS plugin directory (see Notes below)
18 |     <li>Test the plugin by enabling it in the QGIS plugin manager and enabling the provider in the Processing Options
19 |     <li>Customize it by editing the implementation file <b>${TemplateModuleName}_algorithm.py</b>
20 | </ol>
21 | Notes:
22 | <ul>
23 |     <li>You can use the <b>Makefile</b> to compile and deploy when you
24 |         make changes. This requires GNU make (gmake). The Makefile is ready to use, however you 
25 |         will have to edit it to add addional Python source files, dialogs, and translations.
26 |     <li>You can also use <b>pb_tool</b> to compile and deploy your plugin. Tweak the <i>pb_tool.cfg</i> file included with your plugin as you add files. Install <b>pb_tool</b> using 
27 |         <i>pip</i> or <i>easy_install</i>. See <b>http://loc8.cc/pb_tool</b> for more information.
28 | </ul>
29 | </div>
30 | <div style='font-size:.9em;'>
31 | <p>
32 | For information on writing PyQGIS code, see <b>http://loc8.cc/pyqgis_resources</b> for a list of resources.
33 | </p>
34 | </div>
35 | <p>
36 | &copy;2011-2018 GeoApt LLC - geoapt.com 
37 | </p>
38 | </body>
39 | </html>
40 | 


--------------------------------------------------------------------------------
/plugin_templates/processing_provider/wizard_form_base.ui:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <ui version="4.0">
  3 |  <class>Frame</class>
  4 |  <widget class="QFrame" name="Frame">
  5 |   <property name="geometry">
  6 |    <rect>
  7 |     <x>0</x>
  8 |     <y>0</y>
  9 |     <width>200</width>
 10 |     <height>100</height>
 11 |    </rect>
 12 |   </property>
 13 |   <layout class="QGridLayout" name="gridLayout">
 14 |    <item row="2" column="1">
 15 |     <widget class="QLineEdit" name="provider_name_text">
 16 |      <property name="minimumSize">
 17 |       <size>
 18 |        <width>300</width>
 19 |        <height>0</height>
 20 |       </size>
 21 |      </property>
 22 |      <property name="maximumSize">
 23 |       <size>
 24 |        <width>16777215</width>
 25 |        <height>16777215</height>
 26 |       </size>
 27 |      </property>
 28 |      <property name="toolTip">
 29 |       <string>This is the name that will appear on the toolbox group e.g. Example provider.</string>
 30 |      </property>
 31 |      <property name="text">
 32 |       <string/>
 33 |      </property>
 34 |      <property name="placeholderText">
 35 |       <string>e.g. Example provider</string>
 36 |      </property>
 37 |     </widget>
 38 |    </item>
 39 |    <item row="3" column="0">
 40 |     <widget class="QLabel" name="menu_text_label_4">
 41 |      <property name="minimumSize">
 42 |       <size>
 43 |        <width>150</width>
 44 |        <height>0</height>
 45 |       </size>
 46 |      </property>
 47 |      <property name="maximumSize">
 48 |       <size>
 49 |        <width>16777215</width>
 50 |        <height>16777215</height>
 51 |       </size>
 52 |      </property>
 53 |      <property name="text">
 54 |       <string>Provider description</string>
 55 |      </property>
 56 |      <property name="alignment">
 57 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
 58 |      </property>
 59 |      <property name="buddy">
 60 |       <cstring>algo_name_text</cstring>
 61 |      </property>
 62 |     </widget>
 63 |    </item>
 64 |    <item row="1" column="0">
 65 |     <widget class="QLabel" name="menu_text_label_2">
 66 |      <property name="minimumSize">
 67 |       <size>
 68 |        <width>150</width>
 69 |        <height>0</height>
 70 |       </size>
 71 |      </property>
 72 |      <property name="maximumSize">
 73 |       <size>
 74 |        <width>16777215</width>
 75 |        <height>16777215</height>
 76 |       </size>
 77 |      </property>
 78 |      <property name="text">
 79 |       <string>Algorithm group</string>
 80 |      </property>
 81 |      <property name="alignment">
 82 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
 83 |      </property>
 84 |      <property name="buddy">
 85 |       <cstring>algo_name_text</cstring>
 86 |      </property>
 87 |     </widget>
 88 |    </item>
 89 |    <item row="2" column="0">
 90 |     <widget class="QLabel" name="menu_text_label_3">
 91 |      <property name="minimumSize">
 92 |       <size>
 93 |        <width>150</width>
 94 |        <height>0</height>
 95 |       </size>
 96 |      </property>
 97 |      <property name="maximumSize">
 98 |       <size>
 99 |        <width>16777215</width>
100 |        <height>16777215</height>
101 |       </size>
102 |      </property>
103 |      <property name="text">
104 |       <string>Provider name</string>
105 |      </property>
106 |      <property name="alignment">
107 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
108 |      </property>
109 |      <property name="buddy">
110 |       <cstring>algo_name_text</cstring>
111 |      </property>
112 |     </widget>
113 |    </item>
114 |    <item row="4" column="0">
115 |     <spacer name="verticalSpacer">
116 |      <property name="orientation">
117 |       <enum>Qt::Vertical</enum>
118 |      </property>
119 |      <property name="sizeHint" stdset="0">
120 |       <size>
121 |        <width>20</width>
122 |        <height>40</height>
123 |       </size>
124 |      </property>
125 |     </spacer>
126 |    </item>
127 |    <item row="0" column="1">
128 |     <widget class="QLineEdit" name="algo_name_text">
129 |      <property name="minimumSize">
130 |       <size>
131 |        <width>300</width>
132 |        <height>0</height>
133 |       </size>
134 |      </property>
135 |      <property name="maximumSize">
136 |       <size>
137 |        <width>16777215</width>
138 |        <height>16777215</height>
139 |       </size>
140 |      </property>
141 |      <property name="toolTip">
142 |       <string>The name that the user will see in the toolbox e.g. Create copy of layer.</string>
143 |      </property>
144 |      <property name="text">
145 |       <string/>
146 |      </property>
147 |      <property name="placeholderText">
148 |       <string>e.g. Create copy of layer</string>
149 |      </property>
150 |     </widget>
151 |    </item>
152 |    <item row="1" column="1">
153 |     <widget class="QLineEdit" name="algo_group_text">
154 |      <property name="minimumSize">
155 |       <size>
156 |        <width>300</width>
157 |        <height>0</height>
158 |       </size>
159 |      </property>
160 |      <property name="maximumSize">
161 |       <size>
162 |        <width>16777215</width>
163 |        <height>16777215</height>
164 |       </size>
165 |      </property>
166 |      <property name="toolTip">
167 |       <string>The branch of the toolbox under which the algorithm will appear e.g. Algorithms for vector layers.</string>
168 |      </property>
169 |      <property name="text">
170 |       <string/>
171 |      </property>
172 |      <property name="placeholderText">
173 |       <string>e.g. Algorithms for vector layers</string>
174 |      </property>
175 |     </widget>
176 |    </item>
177 |    <item row="3" column="1">
178 |     <widget class="QLineEdit" name="provider_descr_text">
179 |      <property name="minimumSize">
180 |       <size>
181 |        <width>300</width>
182 |        <height>0</height>
183 |       </size>
184 |      </property>
185 |      <property name="maximumSize">
186 |       <size>
187 |        <width>16777215</width>
188 |        <height>16777215</height>
189 |       </size>
190 |      </property>
191 |      <property name="toolTip">
192 |       <string>This is the providers full name. e.g. Example algorithms.</string>
193 |      </property>
194 |      <property name="text">
195 |       <string/>
196 |      </property>
197 |      <property name="placeholderText">
198 |       <string>e.g. Example algorithms</string>
199 |      </property>
200 |     </widget>
201 |    </item>
202 |    <item row="0" column="0">
203 |     <widget class="QLabel" name="menu_text_label">
204 |      <property name="minimumSize">
205 |       <size>
206 |        <width>150</width>
207 |        <height>0</height>
208 |       </size>
209 |      </property>
210 |      <property name="maximumSize">
211 |       <size>
212 |        <width>16777215</width>
213 |        <height>16777215</height>
214 |       </size>
215 |      </property>
216 |      <property name="text">
217 |       <string>Algorithm name</string>
218 |      </property>
219 |      <property name="alignment">
220 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
221 |      </property>
222 |      <property name="buddy">
223 |       <cstring>algo_name_text</cstring>
224 |      </property>
225 |     </widget>
226 |    </item>
227 |   </layout>
228 |  </widget>
229 |  <tabstops>
230 |   <tabstop>algo_name_text</tabstop>
231 |   <tabstop>algo_group_text</tabstop>
232 |   <tabstop>provider_name_text</tabstop>
233 |   <tabstop>provider_descr_text</tabstop>
234 |  </tabstops>
235 |  <resources/>
236 |  <connections/>
237 | </ui>
238 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/help/Makefile:
--------------------------------------------------------------------------------
  1 | # Makefile for Sphinx documentation
  2 | #
  3 | 
  4 | # You can set these variables from the command line.
  5 | SPHINXOPTS    =
  6 | SPHINXBUILD   = sphinx-build
  7 | PAPER         =
  8 | BUILDDIR      = build
  9 | 
 10 | # Internal variables.
 11 | PAPEROPT_a4     = -D latex_paper_size=a4
 12 | PAPEROPT_letter = -D latex_paper_size=letter
 13 | ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 14 | 
 15 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 16 | 
 17 | help:
 18 | 	@echo "Please use \`make <target>' where <target> is one of"
 19 | 	@echo "  html       to make standalone HTML files"
 20 | 	@echo "  dirhtml    to make HTML files named index.html in directories"
 21 | 	@echo "  singlehtml to make a single large HTML file"
 22 | 	@echo "  pickle     to make pickle files"
 23 | 	@echo "  json       to make JSON files"
 24 | 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 25 | 	@echo "  qthelp     to make HTML files and a qthelp project"
 26 | 	@echo "  devhelp    to make HTML files and a Devhelp project"
 27 | 	@echo "  epub       to make an epub"
 28 | 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 29 | 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 30 | 	@echo "  text       to make text files"
 31 | 	@echo "  man        to make manual pages"
 32 | 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 33 | 	@echo "  linkcheck  to check all external links for integrity"
 34 | 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 35 | 
 36 | clean:
 37 | 	-rm -rf $(BUILDDIR)/*
 38 | 
 39 | html:
 40 | 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 41 | 	@echo
 42 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 43 | 
 44 | dirhtml:
 45 | 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 46 | 	@echo
 47 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 48 | 
 49 | singlehtml:
 50 | 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 51 | 	@echo
 52 | 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 53 | 
 54 | pickle:
 55 | 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 56 | 	@echo
 57 | 	@echo "Build finished; now you can process the pickle files."
 58 | 
 59 | json:
 60 | 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 61 | 	@echo
 62 | 	@echo "Build finished; now you can process the JSON files."
 63 | 
 64 | htmlhelp:
 65 | 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 66 | 	@echo
 67 | 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 68 | 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 69 | 
 70 | qthelp:
 71 | 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 72 | 	@echo
 73 | 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 74 | 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 75 | 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/template_class.qhcp"
 76 | 	@echo "To view the help file:"
 77 | 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/template_class.qhc"
 78 | 
 79 | devhelp:
 80 | 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 81 | 	@echo
 82 | 	@echo "Build finished."
 83 | 	@echo "To view the help file:"
 84 | 	@echo "# mkdir -p $$HOME/.local/share/devhelp/template_class"
 85 | 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/template_class"
 86 | 	@echo "# devhelp"
 87 | 
 88 | epub:
 89 | 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 90 | 	@echo
 91 | 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 92 | 
 93 | latex:
 94 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 95 | 	@echo
 96 | 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 97 | 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
 98 | 	      "(use \`make latexpdf' here to do that automatically)."
 99 | 
100 | latexpdf:
101 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102 | 	@echo "Running LaTeX files through pdflatex..."
103 | 	make -C $(BUILDDIR)/latex all-pdf
104 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105 | 
106 | text:
107 | 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108 | 	@echo
109 | 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
110 | 
111 | man:
112 | 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
113 | 	@echo
114 | 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
115 | 
116 | changes:
117 | 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
118 | 	@echo
119 | 	@echo "The overview file is in $(BUILDDIR)/changes."
120 | 
121 | linkcheck:
122 | 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
123 | 	@echo
124 | 	@echo "Link check complete; look for any errors in the above output " \
125 | 	      "or in $(BUILDDIR)/linkcheck/output.txt."
126 | 
127 | doctest:
128 | 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129 | 	@echo "Testing of doctests in the sources finished, look at the " \
130 | 	      "results in $(BUILDDIR)/doctest/output.txt."
131 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/help/make.bat:
--------------------------------------------------------------------------------
  1 | @ECHO OFF
  2 | 
  3 | REM Command file for Sphinx documentation
  4 | 
  5 | if "%SPHINXBUILD%" == "" (
  6 | 	set SPHINXBUILD=sphinx-build
  7 | )
  8 | set BUILDDIR=build
  9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
 10 | if NOT "%PAPER%" == "" (
 11 | 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 12 | )
 13 | 
 14 | if "%1" == "" goto help
 15 | 
 16 | if "%1" == "help" (
 17 | 	:help
 18 | 	echo.Please use `make ^<target^>` where ^<target^> is one of
 19 | 	echo.  html       to make standalone HTML files
 20 | 	echo.  dirhtml    to make HTML files named index.html in directories
 21 | 	echo.  singlehtml to make a single large HTML file
 22 | 	echo.  pickle     to make pickle files
 23 | 	echo.  json       to make JSON files
 24 | 	echo.  htmlhelp   to make HTML files and a HTML help project
 25 | 	echo.  qthelp     to make HTML files and a qthelp project
 26 | 	echo.  devhelp    to make HTML files and a Devhelp project
 27 | 	echo.  epub       to make an epub
 28 | 	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
 29 | 	echo.  text       to make text files
 30 | 	echo.  man        to make manual pages
 31 | 	echo.  changes    to make an overview over all changed/added/deprecated items
 32 | 	echo.  linkcheck  to check all external links for integrity
 33 | 	echo.  doctest    to run all doctests embedded in the documentation if enabled
 34 | 	goto end
 35 | )
 36 | 
 37 | if "%1" == "clean" (
 38 | 	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
 39 | 	del /q /s %BUILDDIR%\*
 40 | 	goto end
 41 | )
 42 | 
 43 | if "%1" == "html" (
 44 | 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 45 | 	echo.
 46 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
 47 | 	goto end
 48 | )
 49 | 
 50 | if "%1" == "dirhtml" (
 51 | 	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
 52 | 	echo.
 53 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
 54 | 	goto end
 55 | )
 56 | 
 57 | if "%1" == "singlehtml" (
 58 | 	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
 59 | 	echo.
 60 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
 61 | 	goto end
 62 | )
 63 | 
 64 | if "%1" == "pickle" (
 65 | 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
 66 | 	echo.
 67 | 	echo.Build finished; now you can process the pickle files.
 68 | 	goto end
 69 | )
 70 | 
 71 | if "%1" == "json" (
 72 | 	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
 73 | 	echo.
 74 | 	echo.Build finished; now you can process the JSON files.
 75 | 	goto end
 76 | )
 77 | 
 78 | if "%1" == "htmlhelp" (
 79 | 	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
 80 | 	echo.
 81 | 	echo.Build finished; now you can run HTML Help Workshop with the ^
 82 | .hhp project file in %BUILDDIR%/htmlhelp.
 83 | 	goto end
 84 | )
 85 | 
 86 | if "%1" == "qthelp" (
 87 | 	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
 88 | 	echo.
 89 | 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 90 | .qhcp project file in %BUILDDIR%/qthelp, like this:
 91 | 	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\template_class.qhcp
 92 | 	echo.To view the help file:
 93 | 	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\template_class.ghc
 94 | 	goto end
 95 | )
 96 | 
 97 | if "%1" == "devhelp" (
 98 | 	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
 99 | 	echo.
100 | 	echo.Build finished.
101 | 	goto end
102 | )
103 | 
104 | if "%1" == "epub" (
105 | 	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
106 | 	echo.
107 | 	echo.Build finished. The epub file is in %BUILDDIR%/epub.
108 | 	goto end
109 | )
110 | 
111 | if "%1" == "latex" (
112 | 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
113 | 	echo.
114 | 	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
115 | 	goto end
116 | )
117 | 
118 | if "%1" == "text" (
119 | 	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
120 | 	echo.
121 | 	echo.Build finished. The text files are in %BUILDDIR%/text.
122 | 	goto end
123 | )
124 | 
125 | if "%1" == "man" (
126 | 	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
127 | 	echo.
128 | 	echo.Build finished. The manual pages are in %BUILDDIR%/man.
129 | 	goto end
130 | )
131 | 
132 | if "%1" == "changes" (
133 | 	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
134 | 	echo.
135 | 	echo.The overview file is in %BUILDDIR%/changes.
136 | 	goto end
137 | )
138 | 
139 | if "%1" == "linkcheck" (
140 | 	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
141 | 	echo.
142 | 	echo.Link check complete; look for any errors in the above output ^
143 | or in %BUILDDIR%/linkcheck/output.txt.
144 | 	goto end
145 | )
146 | 
147 | if "%1" == "doctest" (
148 | 	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
149 | 	echo.
150 | 	echo.Testing of doctests in the sources finished, look at the ^
151 | results in %BUILDDIR%/doctest/output.txt.
152 | 	goto end
153 | )
154 | 
155 | :end
156 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/help/source/index.rst.tmpl:
--------------------------------------------------------------------------------
 1 | .. ${TemplateClass} documentation master file, created by
 2 |    sphinx-quickstart on Sun Feb 12 17:11:03 2012.
 3 |    You can adapt this file completely to your liking, but it should at least
 4 |    contain the root `toctree` directive.
 5 | 
 6 | Welcome to ${TemplateClass}'s documentation!
 7 | ============================================
 8 | 
 9 | Contents:
10 | 
11 | .. toctree::
12 |    :maxdepth: 2
13 | 
14 | Indices and tables
15 | ==================
16 | 
17 | * :ref:`genindex`
18 | * :ref:`modindex`
19 | * :ref:`search`
20 | 
21 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/i18n/af.ts:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE TS><TS version="2.0" language="af" sourcelanguage="en">
 3 | <context>
 4 |     <name>@default</name>
 5 |     <message>
 6 |         <location filename="test_translations.py" line="48"/>
 7 |         <source>Good morning</source>
 8 |         <translation>Goeie more</translation>
 9 |     </message>
10 | </context>
11 | </TS>
12 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/pb_tool.tmpl:
--------------------------------------------------------------------------------
 1 | #/***************************************************************************
 2 | # ${TemplateClass}
 3 | #
 4 | # Configuration file for plugin builder tool (pb_tool)
 5 | # Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 6 | #                            -------------------
 7 | #       begin               : $TemplateBuildDate
 8 | #       copyright           : (C) $TemplateYear by $TemplateAuthor
 9 | #       email               : $TemplateEmail
10 | # ***************************************************************************/
11 | #
12 | #/***************************************************************************
13 | # *                                                                         *
14 | # *   This program is free software; you can redistribute it and/or modify  *
15 | # *   it under the terms of the GNU General Public License as published by  *
16 | # *   the Free Software Foundation; either version 2 of the License, or     *
17 | # *   (at your option) any later version.                                   *
18 | # *                                                                         *
19 | # ***************************************************************************/
20 | # 
21 | # 
22 | # You can install pb_tool using:
23 | #  pip install http://geoapt.net/files/pb_tool.zip
24 | # 
25 | # Consider doing your development (and install of pb_tool) in a virtualenv.
26 | # 
27 | # For details on setting up and using pb_tool, see:
28 | #  http://g-sherman.github.io/plugin_build_tool/
29 | #
30 | # Issues and pull requests here:
31 | # https://github.com/g-sherman/plugin_build_tool:
32 | # 
33 | # Sane defaults for your plugin generated by the Plugin Builder are
34 | # already set below.
35 | # 
36 | # As you add Python source files and UI files to your plugin, add
37 | # them to the appropriate [files] section below.
38 | 
39 | [plugin]
40 | # Name of the plugin. This is the name of the directory that will
41 | # be created in .qgis2/python/plugins
42 | name: ${TemplateModuleName}
43 | 
44 | # Full path to where you want your plugin directory copied. If empty,
45 | # the QGIS default path will be used. Don't include the plugin name in
46 | # the path.
47 | plugin_path:
48 | 
49 | [files]
50 | # Python  files that should be deployed with the plugin
51 | python_files: __init__.py ${TemplateModuleName}.py ${TemplatePyFiles}
52 | 
53 | # The main dialog file that is loaded (not compiled)
54 | main_dialog: ${TemplateUiFiles}
55 | 
56 | # Other ui files for dialogs you create (these will be compiled)
57 | compiled_ui_files: 
58 | 
59 | # Resource file(s) that will be compiled
60 | resource_files: ${TemplateQrcFiles}
61 | 
62 | # Other files required for the plugin
63 | extras: metadata.txt ${TemplateExtraFiles}
64 | 
65 | # Other directories to be deployed with the plugin.
66 | # These must be subdirectories under the plugin directory
67 | extra_dirs:
68 | 
69 | # ISO code(s) for any locales (translations), separated by spaces.
70 | # Corresponding .ts files must exist in the i18n directory
71 | locales:
72 | 
73 | [help]
74 | # the built help directory that should be deployed with the plugin
75 | dir: help/build/html
76 | # the name of the directory to target in the deployed plugin 
77 | target: help
78 | 
79 | 
80 | 
81 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/plugin_upload.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | """This script uploads a plugin package to the plugin repository.
  3 |         Authors: A. Pasotti, V. Picavet
  4 |         git sha              : $TemplateVCSFormat
  5 | """
  6 | 
  7 | import os
  8 | import sys
  9 | import getpass
 10 | import xmlrpc.client
 11 | from optparse import OptionParser
 12 | 
 13 | # Configuration
 14 | PROTOCOL = 'https'
 15 | SERVER = 'plugins.qgis.org'
 16 | PORT = '443'
 17 | ENDPOINT = '/plugins/RPC2/'
 18 | VERBOSE = False
 19 | 
 20 | 
 21 | def main(parameters, arguments):
 22 |     """Main entry point.
 23 | 
 24 |     :param parameters: Command line parameters.
 25 |     :param arguments: Command line arguments.
 26 |     """
 27 |     address = "{protocol}://{username}:{password}@{server}:{port}{endpoint}".format(
 28 |         protocol=PROTOCOL,
 29 |         username=parameters.username,
 30 |         password=parameters.password,
 31 |         server=parameters.server,
 32 |         port=parameters.port,
 33 |         endpoint=ENDPOINT)
 34 |     print("Connecting to: %s" % hide_password(address))
 35 | 
 36 |     server = xmlrpc.client.ServerProxy(address, verbose=VERBOSE)
 37 | 
 38 |     try:
 39 |         with open(arguments[0], 'rb') as handle:
 40 |             plugin_id, version_id = server.plugin.upload(
 41 |                 xmlrpc.client.Binary(handle.read()))
 42 |         print("Plugin ID: %s" % plugin_id)
 43 |         print("Version ID: %s" % version_id)
 44 |     except xmlrpc.client.ProtocolError as err:
 45 |         print("A protocol error occurred")
 46 |         print("URL: %s" % hide_password(err.url, 0))
 47 |         print("HTTP/HTTPS headers: %s" % err.headers)
 48 |         print("Error code: %d" % err.errcode)
 49 |         print("Error message: %s" % err.errmsg)
 50 |     except xmlrpc.client.Fault as err:
 51 |         print("A fault occurred")
 52 |         print("Fault code: %d" % err.faultCode)
 53 |         print("Fault string: %s" % err.faultString)
 54 | 
 55 | 
 56 | def hide_password(url, start=6):
 57 |     """Returns the http url with password part replaced with '*'.
 58 | 
 59 |     :param url: URL to upload the plugin to.
 60 |     :type url: str
 61 | 
 62 |     :param start: Position of start of password.
 63 |     :type start: int
 64 |     """
 65 |     start_position = url.find(':', start) + 1
 66 |     end_position = url.find('@')
 67 |     return "%s%s%s" % (
 68 |         url[:start_position],
 69 |         '*' * (end_position - start_position),
 70 |         url[end_position:])
 71 | 
 72 | 
 73 | if __name__ == "__main__":
 74 |     parser = OptionParser(usage="%prog [options] plugin.zip")
 75 |     parser.add_option(
 76 |         "-w", "--password", dest="password",
 77 |         help="Password for plugin site. "
 78 |              "You can use environment variable 'PLUGIN_UPLOAD_PASSWORD', "
 79 |              "or the password will be prompted on runtime.", metavar="******")
 80 |     parser.add_option(
 81 |         "-u", "--username", dest="username",
 82 |         help="Username of plugin site. "
 83 |              "You can use environment variable 'PLUGIN_UPLOAD_USERNAME', "
 84 |              "or the username will be prompted on runtime.", metavar="user")
 85 |     parser.add_option(
 86 |         "-p", "--port", dest="port",
 87 |         help="Server port to connect to", metavar="80")
 88 |     parser.add_option(
 89 |         "-s", "--server", dest="server",
 90 |         help="Specify server name", metavar="plugins.qgis.org")
 91 |     options, args = parser.parse_args()
 92 |     if len(args) != 1:
 93 |         print("Please specify zip file.\n")
 94 |         parser.print_help()
 95 |         sys.exit(1)
 96 |     if not options.server:
 97 |         options.server = SERVER
 98 |     if not options.port:
 99 |         options.port = PORT
100 |     if not options.username:
101 |         username = os.environ.get('PLUGIN_UPLOAD_USERNAME')
102 |         if username:
103 |             # environment variable
104 |             options.username = username
105 |         else:
106 |             # interactive mode
107 |             username = getpass.getuser()
108 |             print("Please enter user name [%s] :" % username, end=' ')
109 | 
110 |             res = input()
111 |             if res != "":
112 |                 options.username = res
113 |             else:
114 |                 options.username = username
115 |     if not options.password:
116 |         password = os.environ.get('PLUGIN_UPLOAD_PASSWORD')
117 |         if password:
118 |             # environment variable
119 |             options.password = password
120 |         else:
121 |             # interactive mode
122 |             options.password = getpass.getpass()
123 |     main(options, args)
124 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/scripts/compile-strings.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | LRELEASE=$1
 3 | LOCALES=$2
 4 | 
 5 | 
 6 | for LOCALE in ${LOCALES}
 7 | do
 8 |     echo "Processing: ${LOCALE}.ts"
 9 |     # Note we don't use pylupdate with qt .pro file approach as it is flakey
10 |     # about what is made available.
11 |     $LRELEASE i18n/${LOCALE}.ts
12 | done
13 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/scripts/run-env-linux.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | QGIS_PREFIX_PATH=/usr/local/qgis-2.0
 4 | if [ -n "$1" ]; then
 5 |     QGIS_PREFIX_PATH=$1
 6 | fi
 7 | 
 8 | echo ${QGIS_PREFIX_PATH}
 9 | 
10 | 
11 | export QGIS_PREFIX_PATH=${QGIS_PREFIX_PATH}
12 | export QGIS_PATH=${QGIS_PREFIX_PATH}
13 | export LD_LIBRARY_PATH=${QGIS_PREFIX_PATH}/lib
14 | export PYTHONPATH=${QGIS_PREFIX_PATH}/share/qgis/python:${QGIS_PREFIX_PATH}/share/qgis/python/plugins:${PYTHONPATH}
15 | 
16 | echo "QGIS PATH: $QGIS_PREFIX_PATH"
17 | export QGIS_DEBUG=0
18 | export QGIS_LOG_FILE=/tmp/inasafe/realtime/logs/qgis.log
19 | 
20 | export PATH=${QGIS_PREFIX_PATH}/bin:$PATH
21 | 
22 | echo "This script is intended to be sourced to set up your shell to"
23 | echo "use a QGIS 2.0 built in $QGIS_PREFIX_PATH"
24 | echo
25 | echo "To use it do:"
26 | echo "source $BASH_SOURCE /your/optional/install/path"
27 | echo
28 | echo "Then use the make file supplied here e.g. make guitest"
29 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/scripts/update-strings.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | LOCALES=$*
 3 | 
 4 | # Get newest .py files so we don't update strings unnecessarily
 5 | 
 6 | CHANGED_FILES=0
 7 | PYTHON_FILES=`find . -regex ".*\(ui\|py\)$" -type f`
 8 | for PYTHON_FILE in $PYTHON_FILES
 9 | do
10 |   CHANGED=$(stat -c %Y $PYTHON_FILE)
11 |   if [ ${CHANGED} -gt ${CHANGED_FILES} ]
12 |   then
13 |     CHANGED_FILES=${CHANGED}
14 |   fi
15 | done
16 | 
17 | # Qt translation stuff
18 | # for .ts file
19 | UPDATE=false
20 | for LOCALE in ${LOCALES}
21 | do
22 |   TRANSLATION_FILE="i18n/$LOCALE.ts"
23 |   if [ ! -f ${TRANSLATION_FILE} ]
24 |   then
25 |     # Force translation string collection as we have a new language file
26 |     touch ${TRANSLATION_FILE}
27 |     UPDATE=true
28 |     break
29 |   fi
30 | 
31 |   MODIFICATION_TIME=$(stat -c %Y ${TRANSLATION_FILE})
32 |   if [ ${CHANGED_FILES} -gt ${MODIFICATION_TIME} ]
33 |   then
34 |     # Force translation string collection as a .py file has been updated
35 |     UPDATE=true
36 |     break
37 |   fi
38 | done
39 | 
40 | if [ ${UPDATE} == true ]
41 | # retrieve all python files
42 | then
43 |   echo ${PYTHON_FILES}
44 |   # update .ts
45 |   echo "Please provide translations by editing the translation files below:"
46 |   for LOCALE in ${LOCALES}
47 |   do
48 |     echo "i18n/"${LOCALE}".ts"
49 |     # Note we don't use pylupdate with qt .pro file approach as it is flakey
50 |     # about what is made available.
51 |     pylupdate4 -noobsolete ${PYTHON_FILES} -ts i18n/${LOCALE}.ts
52 |   done
53 | else
54 |   echo "No need to edit any translation files (.ts) because no python files"
55 |   echo "has been updated since the last update translation. "
56 | fi
57 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/__init__.py:
--------------------------------------------------------------------------------
1 | # import qgis libs so that ve set the correct sip api version
2 | import qgis   # pylint: disable=W0611  # NOQA


--------------------------------------------------------------------------------
/plugin_templates/shared/test/qgis_interface.py:
--------------------------------------------------------------------------------
  1 | # coding=utf-8
  2 | """QGIS plugin implementation.
  3 | 
  4 | .. note:: This program is free software; you can redistribute it and/or modify
  5 |      it under the terms of the GNU General Public License as published by
  6 |      the Free Software Foundation; either version 2 of the License, or
  7 |      (at your option) any later version.
  8 | 
  9 | .. note:: This source code was copied from the 'postgis viewer' application
 10 |      with original authors:
 11 |      Copyright (c) 2010 by Ivan Mincik, ivan.mincik@gista.sk
 12 |      Copyright (c) 2011 German Carrillo, geotux_tuxman@linuxmail.org
 13 |      Copyright (c) 2014 Tim Sutton, tim@linfiniti.com
 14 | 
 15 | """
 16 | 
 17 | __author__ = 'tim@linfiniti.com'
 18 | __revision__ = '$Format:%H$'
 19 | __date__ = '10/01/2011'
 20 | __copyright__ = (
 21 |     'Copyright (c) 2010 by Ivan Mincik, ivan.mincik@gista.sk and '
 22 |     'Copyright (c) 2011 German Carrillo, geotux_tuxman@linuxmail.org'
 23 |     'Copyright (c) 2014 Tim Sutton, tim@linfiniti.com'
 24 | )
 25 | 
 26 | import logging
 27 | from qgis.PyQt.QtCore import QObject, pyqtSlot, pyqtSignal
 28 | from qgis.core import QgsMapLayerRegistry
 29 | from qgis.gui import QgsMapCanvasLayer
 30 | LOGGER = logging.getLogger('QGIS')
 31 | 
 32 | 
 33 | #noinspection PyMethodMayBeStatic,PyPep8Naming
 34 | class QgisInterface(QObject):
 35 |     """Class to expose QGIS objects and functions to plugins.
 36 | 
 37 |     This class is here for enabling us to run unit tests only,
 38 |     so most methods are simply stubs.
 39 |     """
 40 |     currentLayerChanged = pyqtSignal(QgsMapCanvasLayer)
 41 | 
 42 |     def __init__(self, canvas):
 43 |         """Constructor
 44 |         :param canvas:
 45 |         """
 46 |         QObject.__init__(self)
 47 |         self.canvas = canvas
 48 |         # Set up slots so we can mimic the behaviour of QGIS when layers
 49 |         # are added.
 50 |         LOGGER.debug('Initialising canvas...')
 51 |         # noinspection PyArgumentList
 52 |         QgsMapLayerRegistry.instance().layersAdded.connect(self.addLayers)
 53 |         # noinspection PyArgumentList
 54 |         QgsMapLayerRegistry.instance().layerWasAdded.connect(self.addLayer)
 55 |         # noinspection PyArgumentList
 56 |         QgsMapLayerRegistry.instance().removeAll.connect(self.removeAllLayers)
 57 | 
 58 |         # For processing module
 59 |         self.destCrs = None
 60 | 
 61 |     @pyqtSlot('QStringList')
 62 |     def addLayers(self, layers):
 63 |         """Handle layers being added to the registry so they show up in canvas.
 64 | 
 65 |         :param layers: list<QgsMapLayer> list of map layers that were added
 66 | 
 67 |         .. note:: The QgsInterface api does not include this method,
 68 |             it is added here as a helper to facilitate testing.
 69 |         """
 70 |         #LOGGER.debug('addLayers called on qgis_interface')
 71 |         #LOGGER.debug('Number of layers being added: %s' % len(layers))
 72 |         #LOGGER.debug('Layer Count Before: %s' % len(self.canvas.layers()))
 73 |         current_layers = self.canvas.layers()
 74 |         final_layers = []
 75 |         for layer in current_layers:
 76 |             final_layers.append(QgsMapCanvasLayer(layer))
 77 |         for layer in layers:
 78 |             final_layers.append(QgsMapCanvasLayer(layer))
 79 | 
 80 |         self.canvas.setLayerSet(final_layers)
 81 |         #LOGGER.debug('Layer Count After: %s' % len(self.canvas.layers()))
 82 | 
 83 |     @pyqtSlot('QgsMapLayer')
 84 |     def addLayer(self, layer):
 85 |         """Handle a layer being added to the registry so it shows up in canvas.
 86 | 
 87 |         :param layer: list<QgsMapLayer> list of map layers that were added
 88 | 
 89 |         .. note: The QgsInterface api does not include this method, it is added
 90 |                  here as a helper to facilitate testing.
 91 | 
 92 |         .. note: The addLayer method was deprecated in QGIS 1.8 so you should
 93 |                  not need this method much.
 94 |         """
 95 |         pass
 96 | 
 97 |     @pyqtSlot()
 98 |     def removeAllLayers(self):
 99 |         """Remove layers from the canvas before they get deleted."""
100 |         self.canvas.setLayerSet([])
101 | 
102 |     def newProject(self):
103 |         """Create new project."""
104 |         # noinspection PyArgumentList
105 |         QgsMapLayerRegistry.instance().removeAllMapLayers()
106 | 
107 |     # ---------------- API Mock for QgsInterface follows -------------------
108 | 
109 |     def zoomFull(self):
110 |         """Zoom to the map full extent."""
111 |         pass
112 | 
113 |     def zoomToPrevious(self):
114 |         """Zoom to previous view extent."""
115 |         pass
116 | 
117 |     def zoomToNext(self):
118 |         """Zoom to next view extent."""
119 |         pass
120 | 
121 |     def zoomToActiveLayer(self):
122 |         """Zoom to extent of active layer."""
123 |         pass
124 | 
125 |     def addVectorLayer(self, path, base_name, provider_key):
126 |         """Add a vector layer.
127 | 
128 |         :param path: Path to layer.
129 |         :type path: str
130 | 
131 |         :param base_name: Base name for layer.
132 |         :type base_name: str
133 | 
134 |         :param provider_key: Provider key e.g. 'ogr'
135 |         :type provider_key: str
136 |         """
137 |         pass
138 | 
139 |     def addRasterLayer(self, path, base_name):
140 |         """Add a raster layer given a raster layer file name
141 | 
142 |         :param path: Path to layer.
143 |         :type path: str
144 | 
145 |         :param base_name: Base name for layer.
146 |         :type base_name: str
147 |         """
148 |         pass
149 | 
150 |     def activeLayer(self):
151 |         """Get pointer to the active layer (layer selected in the legend)."""
152 |         # noinspection PyArgumentList
153 |         layers = QgsMapLayerRegistry.instance().mapLayers()
154 |         for item in layers:
155 |             return layers[item]
156 | 
157 |     def addToolBarIcon(self, action):
158 |         """Add an icon to the plugins toolbar.
159 | 
160 |         :param action: Action to add to the toolbar.
161 |         :type action: QAction
162 |         """
163 |         pass
164 | 
165 |     def removeToolBarIcon(self, action):
166 |         """Remove an action (icon) from the plugin toolbar.
167 | 
168 |         :param action: Action to add to the toolbar.
169 |         :type action: QAction
170 |         """
171 |         pass
172 | 
173 |     def addToolBar(self, name):
174 |         """Add toolbar with specified name.
175 | 
176 |         :param name: Name for the toolbar.
177 |         :type name: str
178 |         """
179 |         pass
180 | 
181 |     def mapCanvas(self):
182 |         """Return a pointer to the map canvas."""
183 |         return self.canvas
184 | 
185 |     def mainWindow(self):
186 |         """Return a pointer to the main window.
187 | 
188 |         In case of QGIS it returns an instance of QgisApp.
189 |         """
190 |         pass
191 | 
192 |     def addDockWidget(self, area, dock_widget):
193 |         """Add a dock widget to the main window.
194 | 
195 |         :param area: Where in the ui the dock should be placed.
196 |         :type area:
197 | 
198 |         :param dock_widget: A dock widget to add to the UI.
199 |         :type dock_widget: QDockWidget
200 |         """
201 |         pass
202 | 
203 |     def legendInterface(self):
204 |         """Get the legend."""
205 |         return self.canvas
206 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/tenbytenraster.asc:
--------------------------------------------------------------------------------
 1 | NCOLS 10
 2 | NROWS 10
 3 | XLLCENTER 1535380.000000
 4 | YLLCENTER 5083260.000000
 5 | DX 10
 6 | DY 10
 7 | NODATA_VALUE -9999
 8 | 0 1 2 3 4 5 6 7 8 9
 9 | 0 1 2 3 4 5 6 7 8 9
10 | 0 1 2 3 4 5 6 7 8 9
11 | 0 1 2 3 4 5 6 7 8 9
12 | 0 1 2 3 4 5 6 7 8 9
13 | 0 1 2 3 4 5 6 7 8 9
14 | 0 1 2 3 4 5 6 7 8 9
15 | 0 1 2 3 4 5 6 7 8 9
16 | 0 1 2 3 4 5 6 7 8 9
17 | 0 1 2 3 4 5 6 7 8 9
18 | CRS
19 | NOTES
20 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/tenbytenraster.asc.aux.xml:
--------------------------------------------------------------------------------
 1 | <PAMDataset>
 2 |   <Metadata>
 3 |     <MDI key="AREA_OR_POINT">Point</MDI>
 4 |   </Metadata>
 5 |   <PAMRasterBand band="1">
 6 |     <Metadata>
 7 |       <MDI key="STATISTICS_MAXIMUM">9</MDI>
 8 |       <MDI key="STATISTICS_MEAN">4.5</MDI>
 9 |       <MDI key="STATISTICS_MINIMUM">0</MDI>
10 |       <MDI key="STATISTICS_STDDEV">2.872281323269</MDI>
11 |     </Metadata>
12 |   </PAMRasterBand>
13 | </PAMDataset>
14 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/tenbytenraster.keywords:
--------------------------------------------------------------------------------
1 | title: Tenbytenraster
2 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/tenbytenraster.lic:
--------------------------------------------------------------------------------
 1 | <?xml version='1.0' encoding='iso-8859-1'?>
 2 | <ga_license_file>
 3 |   <metadata>
 4 |     <author>Tim Sutton, Linfiniti Consulting CC</author>
 5 |   </metadata>
 6 | 
 7 |   <datafile>
 8 |     <filename>tenbytenraster.asc</filename>
 9 |     <checksum>2700044251</checksum>
10 |     <publishable>Yes</publishable>
11 |     <accountable>Tim Sutton</accountable>
12 |     <source>Tim Sutton (QGIS Source Tree)</source>
13 |     <IP_owner>Tim Sutton</IP_owner>
14 |     <IP_info>This data is publicly available from QGIS Source Tree. The original
15 |     file was created and contributed to QGIS by Tim Sutton.</IP_info>
16 |   </datafile>
17 | 
18 | </ga_license_file>
19 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/tenbytenraster.prj:
--------------------------------------------------------------------------------
1 | GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]


--------------------------------------------------------------------------------
/plugin_templates/shared/test/tenbytenraster.qml:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>
 2 | <qgis version="1.9.0-Master" minimumScale="-4.65661e-10" maximumScale="1e+08" hasScaleBasedVisibilityFlag="0">
 3 |   <pipe>
 4 |     <rasterrenderer opacity="1" alphaBand="0" classificationMax="9" classificationMinMaxOrigin="MinMaxFullExtentExact" band="1" classificationMin="0" type="singlebandpseudocolor">
 5 |       <rasterTransparency/>
 6 |       <rastershader>
 7 |         <colorrampshader colorRampType="INTERPOLATED" clip="0">
 8 |           <item alpha="255" value="0" label="0.000000" color="#d7191c"/>
 9 |           <item alpha="255" value="1" label="1.000000" color="#e75b3a"/>
10 |           <item alpha="255" value="2" label="2.000000" color="#f89d59"/>
11 |           <item alpha="255" value="3" label="3.000000" color="#fdc980"/>
12 |           <item alpha="255" value="4" label="4.000000" color="#feedaa"/>
13 |           <item alpha="255" value="5" label="5.000000" color="#ecf7b9"/>
14 |           <item alpha="255" value="6" label="6.000000" color="#c7e8ad"/>
15 |           <item alpha="255" value="7" label="7.000000" color="#9cd3a6"/>
16 |           <item alpha="255" value="8" label="8.000000" color="#63abb0"/>
17 |           <item alpha="255" value="9" label="9.000000" color="#2b83ba"/>
18 |         </colorrampshader>
19 |       </rastershader>
20 |     </rasterrenderer>
21 |     <brightnesscontrast brightness="0" contrast="0"/>
22 |     <huesaturation colorizeGreen="128" colorizeOn="0" colorizeRed="255" colorizeBlue="128" grayscaleMode="0" saturation="0" colorizeStrength="100"/>
23 |     <rasterresampler maxOversampling="2"/>
24 |   </pipe>
25 |   <blendMode>0</blendMode>
26 | </qgis>
27 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/test_init.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """Tests QGIS plugin init."""
 3 | 
 4 | __author__ = 'Tim Sutton <tim@linfiniti.com>'
 5 | __revision__ = '$Format:%H$'
 6 | __date__ = '17/10/2010'
 7 | __license__ = "GPL"
 8 | __copyright__ = 'Copyright 2012, Australia Indonesia Facility for '
 9 | __copyright__ += 'Disaster Reduction'
10 | 
11 | import os
12 | import unittest
13 | import logging
14 | import configparser
15 | 
16 | LOGGER = logging.getLogger('QGIS')
17 | 
18 | 
19 | class TestInit(unittest.TestCase):
20 |     """Test that the plugin init is usable for QGIS.
21 | 
22 |     Based heavily on the validator class by Alessandro
23 |     Passoti available here:
24 | 
25 |     http://github.com/qgis/qgis-django/blob/master/qgis-app/
26 |              plugins/validator.py
27 | 
28 |     """
29 | 
30 |     def test_read_init(self):
31 |         """Test that the plugin __init__ will validate on plugins.qgis.org."""
32 | 
33 |         # You should update this list according to the latest in
34 |         # https://github.com/qgis/qgis-django/blob/master/qgis-app/
35 |         #        plugins/validator.py
36 | 
37 |         required_metadata = [
38 |             'name',
39 |             'description',
40 |             'version',
41 |             'qgisMinimumVersion',
42 |             'email',
43 |             'author']
44 | 
45 |         file_path = os.path.abspath(os.path.join(
46 |             os.path.dirname(__file__), os.pardir,
47 |             'metadata.txt'))
48 |         LOGGER.info(file_path)
49 |         metadata = []
50 |         parser = configparser.ConfigParser()
51 |         parser.optionxform = str
52 |         parser.read(file_path)
53 |         message = 'Cannot find a section named "general" in %s' % file_path
54 |         assert parser.has_section('general'), message
55 |         metadata.extend(parser.items('general'))
56 | 
57 |         for expectation in required_metadata:
58 |             message = ('Cannot find metadata "%s" in metadata source (%s).' % (
59 |                 expectation, file_path))
60 | 
61 |             self.assertIn(expectation, dict(metadata), message)
62 | 
63 | if __name__ == '__main__':
64 |     unittest.main()
65 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/test_qgis_environment.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """Tests for QGIS functionality.
 3 | 
 4 | 
 5 | .. note:: This program is free software; you can redistribute it and/or modify
 6 |      it under the terms of the GNU General Public License as published by
 7 |      the Free Software Foundation; either version 2 of the License, or
 8 |      (at your option) any later version.
 9 | 
10 | """
11 | __author__ = 'tim@linfiniti.com'
12 | __date__ = '20/01/2011'
13 | __copyright__ = ('Copyright 2012, Australia Indonesia Facility for '
14 |                  'Disaster Reduction')
15 | 
16 | import os
17 | import unittest
18 | from qgis.core import (
19 |     QgsProviderRegistry,
20 |     QgsCoordinateReferenceSystem,
21 |     QgsRasterLayer)
22 | 
23 | from .utilities import get_qgis_app
24 | QGIS_APP = get_qgis_app()
25 | 
26 | 
27 | class QGISTest(unittest.TestCase):
28 |     """Test the QGIS Environment"""
29 | 
30 |     def test_qgis_environment(self):
31 |         """QGIS environment has the expected providers"""
32 | 
33 |         r = QgsProviderRegistry.instance()
34 |         self.assertIn('gdal', r.providerList())
35 |         self.assertIn('ogr', r.providerList())
36 |         self.assertIn('postgres', r.providerList())
37 | 
38 |     def test_projection(self):
39 |         """Test that QGIS properly parses a wkt string.
40 |         """
41 |         crs = QgsCoordinateReferenceSystem()
42 |         wkt = (
43 |             'GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",'
44 |             'SPHEROID["WGS_1984",6378137.0,298.257223563]],'
45 |             'PRIMEM["Greenwich",0.0],UNIT["Degree",'
46 |             '0.0174532925199433]]')
47 |         crs.createFromWkt(wkt)
48 |         auth_id = crs.authid()
49 |         expected_auth_id = 'EPSG:4326'
50 |         self.assertEqual(auth_id, expected_auth_id)
51 | 
52 |         # now test for a loaded layer
53 |         path = os.path.join(os.path.dirname(__file__), 'tenbytenraster.asc')
54 |         title = 'TestRaster'
55 |         layer = QgsRasterLayer(path, title)
56 |         auth_id = layer.crs().authid()
57 |         self.assertEqual(auth_id, expected_auth_id)
58 | 
59 | if __name__ == '__main__':
60 |     unittest.main()
61 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/test_translations.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """Safe Translations Test.
 3 | 
 4 | .. note:: This program is free software; you can redistribute it and/or modify
 5 |      it under the terms of the GNU General Public License as published by
 6 |      the Free Software Foundation; either version 2 of the License, or
 7 |      (at your option) any later version.
 8 | 
 9 | """
10 | from .utilities import get_qgis_app
11 | 
12 | __author__ = 'ismailsunni@yahoo.co.id'
13 | __date__ = '12/10/2011'
14 | __copyright__ = ('Copyright 2012, Australia Indonesia Facility for '
15 |                  'Disaster Reduction')
16 | import unittest
17 | import os
18 | 
19 | from qgis.PyQt.QtCore import QCoreApplication, QTranslator
20 | 
21 | QGIS_APP = get_qgis_app()
22 | 
23 | 
24 | class SafeTranslationsTest(unittest.TestCase):
25 |     """Test translations work."""
26 | 
27 |     def setUp(self):
28 |         """Runs before each test."""
29 |         if 'LANG' in iter(os.environ.keys()):
30 |             os.environ.__delitem__('LANG')
31 | 
32 |     def tearDown(self):
33 |         """Runs after each test."""
34 |         if 'LANG' in iter(os.environ.keys()):
35 |             os.environ.__delitem__('LANG')
36 | 
37 |     def test_qgis_translations(self):
38 |         """Test that translations work."""
39 |         parent_path = os.path.join(__file__, os.path.pardir, os.path.pardir)
40 |         dir_path = os.path.abspath(parent_path)
41 |         file_path = os.path.join(
42 |             dir_path, 'i18n', 'af.qm')
43 |         translator = QTranslator()
44 |         translator.load(file_path)
45 |         QCoreApplication.installTranslator(translator)
46 | 
47 |         expected_message = 'Goeie more'
48 |         real_message = QCoreApplication.translate("@default", 'Good morning')
49 |         self.assertEqual(real_message, expected_message)
50 | 
51 | 
52 | if __name__ == "__main__":
53 |     suite = unittest.makeSuite(SafeTranslationsTest)
54 |     runner = unittest.TextTestRunner(verbosity=2)
55 |     runner.run(suite)
56 | 


--------------------------------------------------------------------------------
/plugin_templates/shared/test/utilities.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """Common functionality used by regression tests."""
 3 | 
 4 | import sys
 5 | import logging
 6 | 
 7 | 
 8 | LOGGER = logging.getLogger('QGIS')
 9 | QGIS_APP = None  # Static variable used to hold hand to running QGIS app
10 | CANVAS = None
11 | PARENT = None
12 | IFACE = None
13 | 
14 | 
15 | def get_qgis_app():
16 |     """ Start one QGIS application to test against.
17 | 
18 |     :returns: Handle to QGIS app, canvas, iface and parent. If there are any
19 |         errors the tuple members will be returned as None.
20 |     :rtype: (QgsApplication, CANVAS, IFACE, PARENT)
21 | 
22 |     If QGIS is already running the handle to that app will be returned.
23 |     """
24 | 
25 |     try:
26 |         from qgis.PyQt import QtGui, QtCore
27 |         from qgis.core import QgsApplication
28 |         from qgis.gui import QgsMapCanvas
29 |         from .qgis_interface import QgisInterface
30 |     except ImportError:
31 |         return None, None, None, None
32 | 
33 |     global QGIS_APP  # pylint: disable=W0603
34 | 
35 |     if QGIS_APP is None:
36 |         gui_flag = True  # All test will run qgis in gui mode
37 |         #noinspection PyPep8Naming
38 |         QGIS_APP = QgsApplication(sys.argv, gui_flag)
39 |         # Make sure QGIS_PREFIX_PATH is set in your env if needed!
40 |         QGIS_APP.initQgis()
41 |         s = QGIS_APP.showSettings()
42 |         LOGGER.debug(s)
43 | 
44 |     global PARENT  # pylint: disable=W0603
45 |     if PARENT is None:
46 |         #noinspection PyPep8Naming
47 |         PARENT = QtGui.QWidget()
48 | 
49 |     global CANVAS  # pylint: disable=W0603
50 |     if CANVAS is None:
51 |         #noinspection PyPep8Naming
52 |         CANVAS = QgsMapCanvas(PARENT)
53 |         CANVAS.resize(QtCore.QSize(400, 400))
54 | 
55 |     global IFACE  # pylint: disable=W0603
56 |     if IFACE is None:
57 |         # QgisInterface is a stub implementation of the QGIS plugin interface
58 |         #noinspection PyPep8Naming
59 |         IFACE = QgisInterface(CANVAS)
60 | 
61 |     return QGIS_APP, CANVAS, IFACE, PARENT
62 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/plugin_templates/toolbutton_with_dialog/__init__.py


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/plugin_template.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  PluginTemplate
 5 |                                  A QGIS plugin
 6 |  plugin_template
 7 |                               -------------------
 8 |         begin                : 2015-03-17
 9 |         git sha              : $Format:%H$
10 |         copyright            : (C) 2015 by Pirmin Kalberer
11 |         email                : pka@sourcepole.ch
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 | """
23 | 
24 | import os
25 | from ..plugin_template import PluginTemplate
26 | from ...qgis_dirs import deployment_dir
27 | 
28 | class ToolbuttonWithDialogPluginTemplate(PluginTemplate):
29 | 
30 |     def descr(self):
31 |         return "Tool button with dialog"
32 | 
33 |     def subdir(self):
34 |         return os.path.dirname(__file__)
35 | 
36 |     def template_map(self, specification, dialog):
37 |         menu_text = dialog.template_subframe.menu_text.text()
38 |         menu = dialog.template_subframe.menu_location.currentText()
39 |         # Munge the plugin menu function based on user choice
40 |         if menu == 'Plugins':
41 |             add_method = 'addPluginToMenu'
42 |             remove_method = 'removePluginMenu'
43 |         else:
44 |             add_method = 'addPluginTo{}Menu'.format(menu)
45 |             remove_method = 'removePlugin{}Menu'.format(menu)
46 |         self.category = menu
47 |         return {
48 |             # Makefile
49 |             'TemplatePyFiles': '%s_dialog.py' % specification.module_name,
50 |             'TemplateUiFiles': '%s_dialog_base.ui' % specification.module_name,
51 |             'TemplateExtraFiles': 'icon.png',
52 |             'TemplateQrcFiles': 'resources.qrc',
53 |             'TemplateRcFiles': "resources.py",
54 |             'TemplateQGISDir': deployment_dir,
55 |             # Metadata
56 |             'TemplateHasProcessingProvider': False,
57 |             # Menu
58 |             'TemplateMenuText': menu_text,
59 |             'TemplateMenuAddMethod': add_method,
60 |             'TemplateMenuRemoveMethod': remove_method,
61 |         }
62 | 
63 |     def template_files(self, specification):
64 |         result = {
65 |             'module_name_dialog.tmpl':
66 |             '%s_dialog.py' % specification.module_name,
67 |             'module_name_dialog_base.ui.tmpl':
68 |             '%s_dialog_base.ui' % specification.module_name,
69 |             'resources.tmpl': 'resources.qrc',
70 |         }
71 |         if specification.gen_tests:
72 |             result.update({
73 |                 'test/test_module_name_dialog.templ':
74 |                 'test/test_%s_dialog.py' % specification.module_name,
75 |                 'test/test_resources.templ': 'test/test_resources.py'
76 |             })
77 |         return result
78 | 
79 |     def copy_files(self, specification):
80 |         return {
81 |             'icon.png': 'icon.png'
82 |         }
83 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/__init__.tmpl:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  ${TemplateClass}
 5 |                                  A QGIS plugin
 6 |  $TemplateDescription
 7 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 8 |                              -------------------
 9 |         begin                : $TemplateBuildDate
10 |         copyright            : (C) $TemplateYear by $TemplateAuthor
11 |         email                : $TemplateEmail
12 |         git sha              : $TemplateVCSFormat
13 |  ***************************************************************************/
14 | 
15 | /***************************************************************************
16 |  *                                                                         *
17 |  *   This program is free software; you can redistribute it and/or modify  *
18 |  *   it under the terms of the GNU General Public License as published by  *
19 |  *   the Free Software Foundation; either version 2 of the License, or     *
20 |  *   (at your option) any later version.                                   *
21 |  *                                                                         *
22 |  ***************************************************************************/
23 |  This script initializes the plugin, making it known to QGIS.
24 | """
25 | 
26 | 
27 | # noinspection PyPep8Naming
28 | def classFactory(iface):  # pylint: disable=invalid-name
29 |     """Load ${TemplateClass} class from file ${TemplateClass}.
30 | 
31 |     :param iface: A QGIS interface instance.
32 |     :type iface: QgsInterface
33 |     """
34 |     #
35 |     from .${TemplateModuleName} import ${TemplateClass}
36 |     return ${TemplateClass}(iface)
37 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/plugin_templates/toolbutton_with_dialog/template/icon.png


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/module_name.tmpl:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | """
  3 | /***************************************************************************
  4 |  $TemplateClass
  5 |                                  A QGIS plugin
  6 |  $TemplateDescription
  7 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
  8 |                               -------------------
  9 |         begin                : $TemplateBuildDate
 10 |         git sha              : $TemplateVCSFormat
 11 |         copyright            : (C) $TemplateYear by $TemplateAuthor
 12 |         email                : $TemplateEmail
 13 |  ***************************************************************************/
 14 | 
 15 | /***************************************************************************
 16 |  *                                                                         *
 17 |  *   This program is free software; you can redistribute it and/or modify  *
 18 |  *   it under the terms of the GNU General Public License as published by  *
 19 |  *   the Free Software Foundation; either version 2 of the License, or     *
 20 |  *   (at your option) any later version.                                   *
 21 |  *                                                                         *
 22 |  ***************************************************************************/
 23 | """
 24 | from qgis.PyQt.QtCore import QLocale, QSettings, QTranslator, QCoreApplication
 25 | from qgis.PyQt.QtGui import QIcon
 26 | from qgis.PyQt.QtWidgets import QAction
 27 | 
 28 | # Initialize Qt resources from file resources.py
 29 | from .resources import *
 30 | # Import the code for the dialog
 31 | from .${TemplateModuleName}_dialog import ${TemplateClass}Dialog
 32 | import os.path
 33 | 
 34 | 
 35 | class ${TemplateClass}:
 36 |     """QGIS Plugin Implementation."""
 37 | 
 38 |     def __init__(self, iface):
 39 |         """Constructor.
 40 | 
 41 |         :param iface: An interface instance that will be passed to this class
 42 |             which provides the hook by which you can manipulate the QGIS
 43 |             application at run time.
 44 |         :type iface: QgsInterface
 45 |         """
 46 |         # Save reference to the QGIS interface
 47 |         self.iface = iface
 48 |         # initialize plugin directory
 49 |         self.plugin_dir = os.path.dirname(__file__)
 50 |         # initialize locale
 51 |         locale = QSettings().value('locale/userLocale', QLocale().name())[0:2]
 52 |         locale_path = os.path.join(
 53 |             self.plugin_dir,
 54 |             'i18n',
 55 |             '${TemplateClass}_{}.qm'.format(locale))
 56 | 
 57 |         if os.path.exists(locale_path):
 58 |             self.translator = QTranslator()
 59 |             self.translator.load(locale_path)
 60 |             QCoreApplication.installTranslator(self.translator)
 61 | 
 62 |         # Declare instance attributes
 63 |         self.actions = []
 64 |         self.menu = self.tr(u'&${TemplateTitle}')
 65 | 
 66 |         # Check if plugin was started the first time in current QGIS session
 67 |         # Must be set in initGui() to survive plugin reloads
 68 |         self.first_start = None
 69 | 
 70 |     # noinspection PyMethodMayBeStatic
 71 |     def tr(self, message):
 72 |         """Get the translation for a string using Qt translation API.
 73 | 
 74 |         We implement this ourselves since we do not inherit QObject.
 75 | 
 76 |         :param message: String for translation.
 77 |         :type message: str, QString
 78 | 
 79 |         :returns: Translated version of message.
 80 |         :rtype: QString
 81 |         """
 82 |         # noinspection PyTypeChecker,PyArgumentList,PyCallByClass
 83 |         return QCoreApplication.translate('${TemplateClass}', message)
 84 | 
 85 | 
 86 |     def add_action(
 87 |         self,
 88 |         icon_path,
 89 |         text,
 90 |         callback,
 91 |         enabled_flag=True,
 92 |         add_to_menu=True,
 93 |         add_to_toolbar=True,
 94 |         status_tip=None,
 95 |         whats_this=None,
 96 |         parent=None):
 97 |         """Add a toolbar icon to the toolbar.
 98 | 
 99 |         :param icon_path: Path to the icon for this action. Can be a resource
100 |             path (e.g. ':/plugins/foo/bar.png') or a normal file system path.
101 |         :type icon_path: str
102 | 
103 |         :param text: Text that should be shown in menu items for this action.
104 |         :type text: str
105 | 
106 |         :param callback: Function to be called when the action is triggered.
107 |         :type callback: function
108 | 
109 |         :param enabled_flag: A flag indicating if the action should be enabled
110 |             by default. Defaults to True.
111 |         :type enabled_flag: bool
112 | 
113 |         :param add_to_menu: Flag indicating whether the action should also
114 |             be added to the menu. Defaults to True.
115 |         :type add_to_menu: bool
116 | 
117 |         :param add_to_toolbar: Flag indicating whether the action should also
118 |             be added to the toolbar. Defaults to True.
119 |         :type add_to_toolbar: bool
120 | 
121 |         :param status_tip: Optional text to show in a popup when mouse pointer
122 |             hovers over the action.
123 |         :type status_tip: str
124 | 
125 |         :param parent: Parent widget for the new action. Defaults None.
126 |         :type parent: QWidget
127 | 
128 |         :param whats_this: Optional text to show in the status bar when the
129 |             mouse pointer hovers over the action.
130 | 
131 |         :returns: The action that was created. Note that the action is also
132 |             added to self.actions list.
133 |         :rtype: QAction
134 |         """
135 | 
136 |         icon = QIcon(icon_path)
137 |         action = QAction(icon, text, parent)
138 |         action.triggered.connect(callback)
139 |         action.setEnabled(enabled_flag)
140 | 
141 |         if status_tip is not None:
142 |             action.setStatusTip(status_tip)
143 | 
144 |         if whats_this is not None:
145 |             action.setWhatsThis(whats_this)
146 | 
147 |         if add_to_toolbar:
148 |             # Adds plugin icon to Plugins toolbar
149 |             self.iface.addToolBarIcon(action)
150 | 
151 |         if add_to_menu:
152 |             self.iface.${TemplateMenuAddMethod}(
153 |                 self.menu,
154 |                 action)
155 | 
156 |         self.actions.append(action)
157 | 
158 |         return action
159 | 
160 |     def initGui(self):
161 |         """Create the menu entries and toolbar icons inside the QGIS GUI."""
162 | 
163 |         icon_path = ':/plugins/${TemplateModuleName}/icon.png'
164 |         self.add_action(
165 |             icon_path,
166 |             text=self.tr(u'$TemplateMenuText'),
167 |             callback=self.run,
168 |             parent=self.iface.mainWindow())
169 | 
170 |         # will be set False in run()
171 |         self.first_start = True
172 | 
173 | 
174 |     def unload(self):
175 |         """Removes the plugin menu item and icon from QGIS GUI."""
176 |         for action in self.actions:
177 |             self.iface.${TemplateMenuRemoveMethod}(
178 |                 self.tr(u'&${TemplateTitle}'),
179 |                 action)
180 |             self.iface.removeToolBarIcon(action)
181 | 
182 | 
183 |     def run(self):
184 |         """Run method that performs all the real work"""
185 | 
186 |         # Create the dialog with elements (after translation) and keep reference
187 |         # Only create GUI ONCE in callback, so that it will only load when the plugin is started
188 |         if self.first_start == True:
189 |             self.first_start = False
190 |             self.dlg = ${TemplateClass}Dialog()
191 | 
192 |         # show the dialog
193 |         self.dlg.show()
194 |         # Run the dialog event loop
195 |         result = self.dlg.exec_()
196 |         # See if OK was pressed
197 |         if result:
198 |             # Do something useful here - delete the line containing pass and
199 |             # substitute with your code.
200 |             pass
201 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/module_name_dialog.tmpl:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  ${TemplateClass}Dialog
 5 |                                  A QGIS plugin
 6 |  $TemplateDescription
 7 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 8 |                              -------------------
 9 |         begin                : $TemplateBuildDate
10 |         git sha              : $TemplateVCSFormat
11 |         copyright            : (C) $TemplateYear by $TemplateAuthor
12 |         email                : $TemplateEmail
13 |  ***************************************************************************/
14 | 
15 | /***************************************************************************
16 |  *                                                                         *
17 |  *   This program is free software; you can redistribute it and/or modify  *
18 |  *   it under the terms of the GNU General Public License as published by  *
19 |  *   the Free Software Foundation; either version 2 of the License, or     *
20 |  *   (at your option) any later version.                                   *
21 |  *                                                                         *
22 |  ***************************************************************************/
23 | """
24 | 
25 | import os
26 | 
27 | from qgis.PyQt import uic
28 | from qgis.PyQt import QtWidgets
29 | 
30 | # This loads your .ui file so that PyQt can populate your plugin with the elements from Qt Designer
31 | FORM_CLASS, _ = uic.loadUiType(os.path.join(
32 |     os.path.dirname(__file__), '${TemplateModuleName}_dialog_base.ui'))
33 | 
34 | 
35 | class ${TemplateClass}Dialog(QtWidgets.QDialog, FORM_CLASS):
36 |     def __init__(self, parent=None):
37 |         """Constructor."""
38 |         super(${TemplateClass}Dialog, self).__init__(parent)
39 |         # Set up the user interface from Designer through FORM_CLASS.
40 |         # After self.setupUi() you can access any designer object by doing
41 |         # self.<objectname>, and you can use autoconnect slots - see
42 |         # http://qt-project.org/doc/qt-4.8/designer-using-a-ui-file.html
43 |         # #widgets-and-dialogs-with-auto-connect
44 |         self.setupUi(self)
45 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/module_name_dialog_base.ui.tmpl:
--------------------------------------------------------------------------------
 1 | <ui version="4.0" >
 2 |  <class>${TemplateClass}DialogBase</class>
 3 |  <widget class="QDialog" name="${TemplateClass}DialogBase" >
 4 |   <property name="geometry" >
 5 |    <rect>
 6 |     <x>0</x>
 7 |     <y>0</y>
 8 |     <width>400</width>
 9 |     <height>300</height>
10 |    </rect>
11 |   </property>
12 |   <property name="windowTitle" >
13 |    <string>${TemplateTitle}</string>
14 |   </property>
15 |   <widget class="QDialogButtonBox" name="button_box" >
16 |    <property name="geometry" >
17 |     <rect>
18 |      <x>30</x>
19 |      <y>240</y>
20 |      <width>341</width>
21 |      <height>32</height>
22 |     </rect>
23 |    </property>
24 |    <property name="orientation" >
25 |     <enum>Qt::Horizontal</enum>
26 |    </property>
27 |    <property name="standardButtons" >
28 |     <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
29 |    </property>
30 |   </widget>
31 |  </widget>
32 |  <resources/>
33 |  <connections>
34 |   <connection>
35 |    <sender>button_box</sender>
36 |    <signal>accepted()</signal>
37 |    <receiver>${TemplateClass}DialogBase</receiver>
38 |    <slot>accept()</slot>
39 |    <hints>
40 |     <hint type="source_label" >
41 |      <x>248</x>
42 |      <y>254</y>
43 |     </hint>
44 |     <hint type="destination_label" >
45 |      <x>157</x>
46 |      <y>274</y>
47 |     </hint>
48 |    </hints>
49 |   </connection>
50 |   <connection>
51 |    <sender>button_box</sender>
52 |    <signal>rejected()</signal>
53 |    <receiver>${TemplateClass}DialogBase</receiver>
54 |    <slot>reject()</slot>
55 |    <hints>
56 |     <hint type="source_label" >
57 |      <x>316</x>
58 |      <y>260</y>
59 |     </hint>
60 |     <hint type="destination_label" >
61 |      <x>286</x>
62 |      <y>274</y>
63 |     </hint>
64 |    </hints>
65 |   </connection>
66 |  </connections>
67 | </ui>
68 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/readme.tmpl:
--------------------------------------------------------------------------------
 1 | Plugin Builder Results
 2 | 
 3 | Your plugin ${TemplateClass} was created in:
 4 |     ${PluginDir}
 5 | 
 6 | Your QGIS plugin directory is located at:
 7 |     ${UserPluginDir}
 8 | 
 9 | What's Next:
10 | 
11 |   * Copy the entire directory containing your new plugin to the QGIS plugin
12 |     directory
13 | 
14 |   * Compile the resources file using pyrcc5
15 | 
16 |   * Run the tests (``make test``)
17 | 
18 |   * Test the plugin by enabling it in the QGIS plugin manager
19 | 
20 |   * Customize it by editing the implementation file: ``${TemplateModuleName}.py``
21 | 
22 |   * Create your own custom icon, replacing the default icon.png
23 | 
24 |   * Modify your user interface by opening ${TemplateClass}_dialog_base.ui in Qt Designer
25 | 
26 |   * You can use the Makefile to compile your Ui and resource files when
27 |     you make changes. This requires GNU make (gmake)
28 | 
29 | For more information, see the PyQGIS Developer Cookbook at:
30 | http://www.qgis.org/pyqgis-cookbook/index.html
31 | 
32 | (C) 2011-2018 GeoApt LLC - geoapt.com
33 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/resources.tmpl:
--------------------------------------------------------------------------------
1 | <RCC>
2 |     <qresource prefix="/plugins/${TemplateModuleName}" >
3 |         <file>icon.png</file>
4 |     </qresource>
5 | </RCC>
6 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/results.tmpl:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <body>
 3 | <h3>Plugin Builder Results</h3>
 4 | 
 5 | Congratulations! You just built a plugin for QGIS!<br/><br />
 6 | 
 7 | <div id='help' style='font-size:.9em;'>
 8 | Your plugin <b>${TemplateClass}</b> was created in:<br>
 9 | &nbsp;&nbsp;<b>${PluginDir}</b>
10 | <p>
11 | Your QGIS plugin directory is located at:<br>
12 | &nbsp;&nbsp;<b>${UserPluginDir}</b>
13 | <p>
14 | <h3>What's Next</h3>
15 | <ol>
16 |     <li>If resources.py is not present in your plugin directory, compile the resources file using pyrcc5 (simply use <b>pb_tool</b> or <b>make</b> if you have automake)
17 |     <li>Optionally, test the generated sources using <b>make test</b> (or run tests from your IDE)
18 |     <li>Copy the entire directory containing your new plugin to the QGIS plugin directory (see Notes below)
19 |     <li>Test the plugin by enabling it in the QGIS plugin manager
20 |     <li>Customize it by editing the implementation file <b>${TemplateModuleName}.py</b>
21 |     <li>Create your own custom icon, replacing the default <b>icon.png</b>
22 |     <li>Modify your user interface by opening <b>${TemplateModuleName}_dialog_base.ui</b> in Qt Designer
23 | </ol>
24 | Notes:
25 | <ul>
26 |     <li>You can use <b>pb_tool</b> to compile, deploy, and manage your plugin. Tweak the <i>pb_tool.cfg</i> file included with your plugin as you add files. Install <b>pb_tool</b> using 
27 |         <i>pip</i> or <i>easy_install</i>. See <b>http://loc8.cc/pb_tool</b> for more information.
28 |     <li>You can also use the <b>Makefile</b> to compile and deploy when you
29 |         make changes. This requires GNU make (gmake). The Makefile is ready to use, however you 
30 |         will have to edit it to add addional Python source files, dialogs, and translations.
31 | </ul>
32 | </div>
33 | <div style='font-size:.9em;'>
34 | <p>
35 | For information on writing PyQGIS code, see <b>http://loc8.cc/pyqgis_resources</b> for a list of resources.
36 | </p>
37 | </div>
38 | <p>
39 | &copy;2011-2019 GeoApt LLC - geoapt.com 
40 | </p>
41 | </body>
42 | </html>
43 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/test/test_module_name_dialog.templ:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """Dialog test.
 3 | 
 4 | .. note:: This program is free software; you can redistribute it and/or modify
 5 |      it under the terms of the GNU General Public License as published by
 6 |      the Free Software Foundation; either version 2 of the License, or
 7 |      (at your option) any later version.
 8 | 
 9 | """
10 | 
11 | __author__ = '$TemplateEmail'
12 | __date__ = '$TemplateBuildDate'
13 | __copyright__ = 'Copyright $TemplateYear, $TemplateAuthor'
14 | 
15 | import unittest
16 | 
17 | from qgis.PyQt.QtGui import QDialogButtonBox, QDialog
18 | 
19 | from ${TemplateModuleName}_dialog import ${TemplateClass}Dialog
20 | 
21 | from utilities import get_qgis_app
22 | QGIS_APP = get_qgis_app()
23 | 
24 | 
25 | class ${TemplateClass}DialogTest(unittest.TestCase):
26 |     """Test dialog works."""
27 | 
28 |     def setUp(self):
29 |         """Runs before each test."""
30 |         self.dialog = ${TemplateClass}Dialog(None)
31 | 
32 |     def tearDown(self):
33 |         """Runs after each test."""
34 |         self.dialog = None
35 | 
36 |     def test_dialog_ok(self):
37 |         """Test we can click OK."""
38 | 
39 |         button = self.dialog.button_box.button(QDialogButtonBox.Ok)
40 |         button.click()
41 |         result = self.dialog.result()
42 |         self.assertEqual(result, QDialog.Accepted)
43 | 
44 |     def test_dialog_cancel(self):
45 |         """Test we can click cancel."""
46 |         button = self.dialog.button_box.button(QDialogButtonBox.Cancel)
47 |         button.click()
48 |         result = self.dialog.result()
49 |         self.assertEqual(result, QDialog.Rejected)
50 | 
51 | if __name__ == "__main__":
52 |     suite = unittest.makeSuite(${TemplateClass}DialogTest)
53 |     runner = unittest.TextTestRunner(verbosity=2)
54 |     runner.run(suite)
55 | 
56 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/template/test/test_resources.templ:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """Resources test.
 3 | 
 4 | .. note:: This program is free software; you can redistribute it and/or modify
 5 |      it under the terms of the GNU General Public License as published by
 6 |      the Free Software Foundation; either version 2 of the License, or
 7 |      (at your option) any later version.
 8 | 
 9 | """
10 | 
11 | __author__ = '$TemplateEmail'
12 | __date__ = '$TemplateBuildDate'
13 | __copyright__ = 'Copyright $TemplateYear, $TemplateAuthor'
14 | 
15 | import unittest
16 | 
17 | from qgis.PyQt.QtGui import QIcon
18 | 
19 | 
20 | 
21 | class ${TemplateClass}DialogTest(unittest.TestCase):
22 |     """Test rerources work."""
23 | 
24 |     def setUp(self):
25 |         """Runs before each test."""
26 |         pass
27 | 
28 |     def tearDown(self):
29 |         """Runs after each test."""
30 |         pass
31 | 
32 |     def test_icon_png(self):
33 |         """Test we can click OK."""
34 |         path = ':/plugins/${TemplateClass}/icon.png'
35 |         icon = QIcon(path)
36 |         self.assertFalse(icon.isNull())
37 | 
38 | if __name__ == "__main__":
39 |     suite = unittest.makeSuite(${TemplateClass}ResourcesTest)
40 |     runner = unittest.TextTestRunner(verbosity=2)
41 |     runner.run(suite)
42 | 
43 | 
44 | 
45 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dialog/wizard_form_base.ui:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <ui version="4.0">
  3 |  <class>Frame</class>
  4 |  <widget class="QFrame" name="Frame">
  5 |   <property name="geometry">
  6 |    <rect>
  7 |     <x>0</x>
  8 |     <y>0</y>
  9 |     <width>699</width>
 10 |     <height>153</height>
 11 |    </rect>
 12 |   </property>
 13 |   <layout class="QGridLayout" name="gridLayout">
 14 |    <item row="1" column="0">
 15 |     <widget class="QLabel" name="menu_label">
 16 |      <property name="minimumSize">
 17 |       <size>
 18 |        <width>150</width>
 19 |        <height>0</height>
 20 |       </size>
 21 |      </property>
 22 |      <property name="maximumSize">
 23 |       <size>
 24 |        <width>16777215</width>
 25 |        <height>16777215</height>
 26 |       </size>
 27 |      </property>
 28 |      <property name="text">
 29 |       <string>Menu</string>
 30 |      </property>
 31 |      <property name="alignment">
 32 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
 33 |      </property>
 34 |     </widget>
 35 |    </item>
 36 |    <item row="1" column="1">
 37 |     <widget class="QComboBox" name="menu_location">
 38 |      <property name="toolTip">
 39 |       <string>Choose the main menu where your plugin will reside</string>
 40 |      </property>
 41 |      <item>
 42 |       <property name="text">
 43 |        <string>Plugins</string>
 44 |       </property>
 45 |      </item>
 46 |      <item>
 47 |       <property name="text">
 48 |        <string>Database</string>
 49 |       </property>
 50 |      </item>
 51 |      <item>
 52 |       <property name="text">
 53 |        <string>Raster</string>
 54 |       </property>
 55 |      </item>
 56 |      <item>
 57 |       <property name="text">
 58 |        <string>Vector</string>
 59 |       </property>
 60 |      </item>
 61 |      <item>
 62 |       <property name="text">
 63 |        <string>Web</string>
 64 |       </property>
 65 |      </item>
 66 |     </widget>
 67 |    </item>
 68 |    <item row="0" column="0">
 69 |     <widget class="QLabel" name="menu_text_label">
 70 |      <property name="minimumSize">
 71 |       <size>
 72 |        <width>150</width>
 73 |        <height>0</height>
 74 |       </size>
 75 |      </property>
 76 |      <property name="maximumSize">
 77 |       <size>
 78 |        <width>16777215</width>
 79 |        <height>16777215</height>
 80 |       </size>
 81 |      </property>
 82 |      <property name="text">
 83 |       <string>Text for the menu item</string>
 84 |      </property>
 85 |      <property name="alignment">
 86 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
 87 |      </property>
 88 |      <property name="buddy">
 89 |       <cstring>menu_text</cstring>
 90 |      </property>
 91 |     </widget>
 92 |    </item>
 93 |    <item row="0" column="1">
 94 |     <widget class="QLineEdit" name="menu_text">
 95 |      <property name="minimumSize">
 96 |       <size>
 97 |        <width>300</width>
 98 |        <height>0</height>
 99 |       </size>
100 |      </property>
101 |      <property name="maximumSize">
102 |       <size>
103 |        <width>16777215</width>
104 |        <height>16777215</height>
105 |       </size>
106 |      </property>
107 |      <property name="toolTip">
108 |       <string>This is the text that will appear in the menu under your Plugin
109 | name e.g. Link photos to points.</string>
110 |      </property>
111 |      <property name="text">
112 |       <string/>
113 |      </property>
114 |      <property name="placeholderText">
115 |       <string>e.g. Link photos to points</string>
116 |      </property>
117 |     </widget>
118 |    </item>
119 |    <item row="2" column="0">
120 |     <spacer name="verticalSpacer">
121 |      <property name="orientation">
122 |       <enum>Qt::Vertical</enum>
123 |      </property>
124 |      <property name="sizeHint" stdset="0">
125 |       <size>
126 |        <width>20</width>
127 |        <height>40</height>
128 |       </size>
129 |      </property>
130 |     </spacer>
131 |    </item>
132 |   </layout>
133 |  </widget>
134 |  <resources/>
135 |  <connections/>
136 | </ui>
137 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/plugin_templates/toolbutton_with_dockwidget/__init__.py


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/plugin_template.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  PluginTemplate
 5 |                                  A QGIS plugin
 6 |  plugin_template
 7 |                               -------------------
 8 |         begin                : 2015-03-17
 9 |         git sha              : $Format:%H$
10 |         copyright            : (C) 2015 by Pirmin Kalberer
11 |         email                : pka@sourcepole.ch
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 | """
23 | 
24 | import os
25 | from ..plugin_template import PluginTemplate
26 | from ...qgis_dirs import deployment_dir
27 | 
28 | 
29 | class ToolbuttonWithDockWidgetPluginTemplate(PluginTemplate):
30 | 
31 |     def descr(self):
32 |         return "Tool button with dock widget"
33 | 
34 |     def subdir(self):
35 |         return os.path.dirname(__file__)
36 | 
37 |     def template_map(self, specification, dialog):
38 |         menu_text = dialog.template_subframe.menu_text.text()
39 |         menu = dialog.template_subframe.menu_location.currentText()
40 |         # Munge the plugin menu function based on user choice
41 |         if menu == 'Plugins':
42 |             add_method = 'addPluginToMenu'
43 |             remove_method = 'removePluginMenu'
44 |         else:
45 |             add_method = 'addPluginTo{}Menu'.format(menu)
46 |             remove_method = 'removePlugin{}Menu'.format(menu)
47 |         self.category = menu
48 | 
49 |         dockwidget_area = dialog.template_subframe.dockwidget_area.currentText()
50 | 
51 |         return {
52 |             # Makefile
53 |             'TemplatePyFiles': '%s_dockwidget.py' % specification.module_name,
54 |             'TemplateUiFiles': '%s_dockwidget_base.ui' % specification.module_name,
55 |             'TemplateExtraFiles': 'icon.png',
56 |             'TemplateQrcFiles': 'resources.qrc',
57 |             'TemplateRcFiles': "resources.py",
58 |             'TemplateQGISDir': deployment_dir,
59 |             # Metadata
60 |             'TemplateHasProcessingProvider': False,
61 |             # Menu
62 |             'TemplateMenuText': menu_text,
63 |             'TemplateMenuAddMethod': add_method,
64 |             'TemplateMenuRemoveMethod': remove_method,
65 |             # DockWidget
66 |             'TemplateDockWidgetArea': 'Qt.{}DockWidgetArea'.format(dockwidget_area)
67 |         }
68 | 
69 |     def template_files(self, specification):
70 |         result = {
71 |             'module_name_dockwidget.tmpl':
72 |             '%s_dockwidget.py' % specification.module_name,
73 |             'module_name_dockwidget_base.ui.tmpl':
74 |             '%s_dockwidget_base.ui' % specification.module_name,
75 |             'resources.tmpl': 'resources.qrc',
76 |         }
77 |         if specification.gen_tests:
78 |             result.update({
79 |                 'test/test_module_name_dockwidget.templ':
80 |                 'test/test_%s_dockwidget.py' % specification.module_name,
81 |                 'test/test_resources.templ': 'test/test_resources.py'
82 |             })
83 |         return result
84 | 
85 |     def copy_files(self, specification):
86 |         return {
87 |             'icon.png': 'icon.png'
88 |         }
89 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/__init__.tmpl:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  ${TemplateClass}
 5 |                                  A QGIS plugin
 6 |  $TemplateDescription
 7 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 8 |                              -------------------
 9 |         begin                : $TemplateBuildDate
10 |         copyright            : (C) $TemplateYear by $TemplateAuthor
11 |         email                : $TemplateEmail
12 |         git sha              : $TemplateVCSFormat
13 |  ***************************************************************************/
14 | 
15 | /***************************************************************************
16 |  *                                                                         *
17 |  *   This program is free software; you can redistribute it and/or modify  *
18 |  *   it under the terms of the GNU General Public License as published by  *
19 |  *   the Free Software Foundation; either version 2 of the License, or     *
20 |  *   (at your option) any later version.                                   *
21 |  *                                                                         *
22 |  ***************************************************************************/
23 |  This script initializes the plugin, making it known to QGIS.
24 | """
25 | 
26 | 
27 | # noinspection PyPep8Naming
28 | def classFactory(iface):  # pylint: disable=invalid-name
29 |     """Load ${TemplateClass} class from file ${TemplateClass}.
30 | 
31 |     :param iface: A QGIS interface instance.
32 |     :type iface: QgsInterface
33 |     """
34 |     #
35 |     from .${TemplateModuleName} import ${TemplateClass}
36 |     return ${TemplateClass}(iface)
37 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/g-sherman/Qgis-Plugin-Builder/e51befa0ab980a57311c6f33d8d026d02da21cc3/plugin_templates/toolbutton_with_dockwidget/template/icon.png


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/module_name_dockwidget.tmpl:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | """
 3 | /***************************************************************************
 4 |  ${TemplateClass}DockWidget
 5 |                                  A QGIS plugin
 6 |  $TemplateDescription
 7 |  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
 8 |                              -------------------
 9 |         begin                : $TemplateBuildDate
10 |         git sha              : $TemplateVCSFormat
11 |         copyright            : (C) $TemplateYear by $TemplateAuthor
12 |         email                : $TemplateEmail
13 |  ***************************************************************************/
14 | 
15 | /***************************************************************************
16 |  *                                                                         *
17 |  *   This program is free software; you can redistribute it and/or modify  *
18 |  *   it under the terms of the GNU General Public License as published by  *
19 |  *   the Free Software Foundation; either version 2 of the License, or     *
20 |  *   (at your option) any later version.                                   *
21 |  *                                                                         *
22 |  ***************************************************************************/
23 | """
24 | 
25 | import os
26 | 
27 | from qgis.PyQt import QtGui, QtWidgets, uic
28 | from qgis.PyQt.QtCore import pyqtSignal
29 | 
30 | FORM_CLASS, _ = uic.loadUiType(os.path.join(
31 |     os.path.dirname(__file__), '${TemplateModuleName}_dockwidget_base.ui'))
32 | 
33 | 
34 | class ${TemplateClass}DockWidget(QtWidgets.QDockWidget, FORM_CLASS):
35 | 
36 |     closingPlugin = pyqtSignal()
37 | 
38 |     def __init__(self, parent=None):
39 |         """Constructor."""
40 |         super(${TemplateClass}DockWidget, self).__init__(parent)
41 |         # Set up the user interface from Designer.
42 |         # After setupUI you can access any designer object by doing
43 |         # self.<objectname>, and you can use autoconnect slots - see
44 |         # http://doc.qt.io/qt-5/designer-using-a-ui-file.html
45 |         # #widgets-and-dialogs-with-auto-connect
46 |         self.setupUi(self)
47 | 
48 |     def closeEvent(self, event):
49 |         self.closingPlugin.emit()
50 |         event.accept()
51 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/module_name_dockwidget_base.ui:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <ui version="4.0">
 3 |  <class>TemplateClassXXDockWidgetBase</class>
 4 |  <widget class="QDockWidget" name="TemplateClassXXDockWidgetBase">
 5 |   <property name="geometry">
 6 |    <rect>
 7 |     <x>0</x>
 8 |     <y>0</y>
 9 |     <width>232</width>
10 |     <height>141</height>
11 |    </rect>
12 |   </property>
13 |   <property name="windowTitle">
14 |    <string>TemplateTitleXX</string>
15 |   </property>
16 |   <widget class="QWidget" name="dockWidgetContents">
17 |    <layout class="QGridLayout" name="gridLayout">
18 |     <item row="0" column="0">
19 |      <widget class="QLabel" name="label">
20 |       <property name="text">
21 |        <string>Replace this QLabel
22 | with the desired
23 | plugin content.</string>
24 |       </property>
25 |      </widget>
26 |     </item>
27 |    </layout>
28 |   </widget>
29 |  </widget>
30 |  <resources/>
31 |  <connections/>
32 | </ui>
33 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/module_name_dockwidget_base.ui.tmpl:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <ui version="4.0">
 3 |  <class>${TemplateClass}DockWidgetBase</class>
 4 |  <widget class="QDockWidget" name="${TemplateClass}DockWidgetBase">
 5 |   <property name="geometry">
 6 |    <rect>
 7 |     <x>0</x>
 8 |     <y>0</y>
 9 |     <width>232</width>
10 |     <height>141</height>
11 |    </rect>
12 |   </property>
13 |   <property name="windowTitle">
14 |    <string>${TemplateTitle}</string>
15 |   </property>
16 |   <widget class="QWidget" name="dockWidgetContents">
17 |    <layout class="QGridLayout" name="gridLayout">
18 |     <item row="0" column="0">
19 |      <widget class="QLabel" name="label">
20 |       <property name="text">
21 |        <string>Replace this QLabel
22 | with the desired
23 | plugin content.</string>
24 |       </property>
25 |      </widget>
26 |     </item>
27 |    </layout>
28 |   </widget>
29 |  </widget>
30 |  <resources/>
31 |  <connections/>
32 | </ui>
33 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/readme.tmpl:
--------------------------------------------------------------------------------
 1 | Plugin Builder Results
 2 | 
 3 | Your plugin ${TemplateClass} was created in:
 4 |     ${PluginDir}
 5 | 
 6 | Your QGIS plugin directory is located at:
 7 |     ${UserPluginDir}
 8 | 
 9 | What's Next:
10 | 
11 |   * Copy the entire directory containing your new plugin to the QGIS plugin
12 |     directory
13 | 
14 |   * Compile the resources file using pyrcc5
15 | 
16 |   * Run the tests (``make test``)
17 | 
18 |   * Test the plugin by enabling it in the QGIS plugin manager
19 | 
20 |   * Customize it by editing the implementation file: ``${TemplateModuleName}.py``
21 | 
22 |   * Create your own custom icon, replacing the default icon.png
23 | 
24 |   * Modify your user interface by opening ${TemplateClass}_dockwidget_base.ui in Qt Designer
25 | 
26 |   * You can use the Makefile to compile your Ui and resource files when
27 |     you make changes. This requires GNU make (gmake)
28 | 
29 | For more information, see the PyQGIS Developer Cookbook at:
30 | http://www.qgis.org/pyqgis-cookbook/index.html
31 | 
32 | (C) 2011-2018 GeoApt LLC - geoapt.com
33 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/resources.tmpl:
--------------------------------------------------------------------------------
1 | <RCC>
2 |     <qresource prefix="/plugins/${TemplateModuleName}" >
3 |         <file>icon.png</file>
4 |     </qresource>
5 | </RCC>
6 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/results.tmpl:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <body>
 3 | <h3>Plugin Builder Results</h3>
 4 | 
 5 | Congratulations! You just built a plugin for QGIS!<br/><br />
 6 | 
 7 | <div id='help' style='font-size:.9em;'>
 8 | Your plugin <b>${TemplateClass}</b> was created in:<br>
 9 | &nbsp;&nbsp;<b>${PluginDir}</b>
10 | <p>
11 | Your QGIS plugin directory is located at:<br>
12 | &nbsp;&nbsp;<b>${UserPluginDir}</b>
13 | <p>
14 | <h3>What's Next</h3>
15 | <ol>
16 |     <li>In your plugin directory, compile the resources file using pyrcc5 (simply run <b>make</b> if you have automake or use <b>pb_tool</b>)
17 |     <li>Test the generated sources using <b>make test</b> (or run tests from your IDE)
18 |     <li>Copy the entire directory containing your new plugin to the QGIS plugin directory (see Notes below)
19 |     <li>Test the plugin by enabling it in the QGIS plugin manager
20 |     <li>Customize it by editing the implementation file <b>${TemplateModuleName}.py</b>
21 |     <li>Create your own custom icon, replacing the default <b>icon.png</b>
22 |     <li>Modify your user interface by opening <b>${TemplateModuleName}_dockwidget_base.ui</b> in Qt Designer
23 | </ol>
24 | Notes:
25 | <ul>
26 |     <li>You can use the <b>Makefile</b> to compile and deploy when you
27 |         make changes. This requires GNU make (gmake). The Makefile is ready to use, however you 
28 |         will have to edit it to add addional Python source files, dialogs, and translations.
29 |     <li>You can also use <b>pb_tool</b> to compile and deploy your plugin. Tweak the <i>pb_tool.cfg</i> file included with your plugin as you add files. Install <b>pb_tool</b> using 
30 |         <i>pip</i> or <i>easy_install</i>. See <b>http://loc8.cc/pb_tool</b> for more information.
31 | </ul>
32 | </div>
33 | <div style='font-size:.9em;'>
34 | <p>
35 | For information on writing PyQGIS code, see <b>http://loc8.cc/pyqgis_resources</b> for a list of resources.
36 | </p>
37 | </div>
38 | <p>
39 | &copy;2011-2018 GeoApt LLC - geoapt.com 
40 | </p>
41 | </body>
42 | </html>
43 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/test/test_module_name_dockwidget.templ:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """DockWidget test.
 3 | 
 4 | .. note:: This program is free software; you can redistribute it and/or modify
 5 |      it under the terms of the GNU General Public License as published by
 6 |      the Free Software Foundation; either version 2 of the License, or
 7 |      (at your option) any later version.
 8 | 
 9 | """
10 | 
11 | __author__ = '$TemplateEmail'
12 | __date__ = '$TemplateBuildDate'
13 | __copyright__ = 'Copyright $TemplateYear, $TemplateAuthor'
14 | 
15 | import unittest
16 | 
17 | from qgis.PyQt.QtGui import QDockWidget
18 | 
19 | from ${TemplateModuleName}_dockwidget import ${TemplateClass}DockWidget
20 | 
21 | from utilities import get_qgis_app
22 | 
23 | QGIS_APP = get_qgis_app()
24 | 
25 | 
26 | class ${TemplateClass}DockWidgetTest(unittest.TestCase):
27 |     """Test dockwidget works."""
28 | 
29 |     def setUp(self):
30 |         """Runs before each test."""
31 |         self.dockwidget = ${TemplateClass}DockWidget(None)
32 | 
33 |     def tearDown(self):
34 |         """Runs after each test."""
35 |         self.dockwidget = None
36 | 
37 |     def test_dockwidget_ok(self):
38 |         """Test we can click OK."""
39 |         pass
40 | 
41 | if __name__ == "__main__":
42 |     suite = unittest.makeSuite(${TemplateClass}DialogTest)
43 |     runner = unittest.TextTestRunner(verbosity=2)
44 |     runner.run(suite)
45 | 
46 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/template/test/test_resources.templ:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """Resources test.
 3 | 
 4 | .. note:: This program is free software; you can redistribute it and/or modify
 5 |      it under the terms of the GNU General Public License as published by
 6 |      the Free Software Foundation; either version 2 of the License, or
 7 |      (at your option) any later version.
 8 | 
 9 | """
10 | 
11 | __author__ = '$TemplateEmail'
12 | __date__ = '$TemplateBuildDate'
13 | __copyright__ = 'Copyright $TemplateYear, $TemplateAuthor'
14 | 
15 | import unittest
16 | 
17 | from qgis.PyQt.QtGui import QIcon
18 | 
19 | 
20 | 
21 | class ${TemplateClass}DialogTest(unittest.TestCase):
22 |     """Test rerources work."""
23 | 
24 |     def setUp(self):
25 |         """Runs before each test."""
26 |         pass
27 | 
28 |     def tearDown(self):
29 |         """Runs after each test."""
30 |         pass
31 | 
32 |     def test_icon_png(self):
33 |         """Test we can click OK."""
34 |         path = ':/plugins/${TemplateClass}/icon.png'
35 |         icon = QIcon(path)
36 |         self.assertFalse(icon.isNull())
37 | 
38 | if __name__ == "__main__":
39 |     suite = unittest.makeSuite(${TemplateClass}ResourcesTest)
40 |     runner = unittest.TextTestRunner(verbosity=2)
41 |     runner.run(suite)
42 | 
43 | 
44 | 
45 | 


--------------------------------------------------------------------------------
/plugin_templates/toolbutton_with_dockwidget/wizard_form_base.ui:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <ui version="4.0">
  3 |  <class>Frame</class>
  4 |  <widget class="QFrame" name="Frame">
  5 |   <property name="geometry">
  6 |    <rect>
  7 |     <x>0</x>
  8 |     <y>0</y>
  9 |     <width>699</width>
 10 |     <height>216</height>
 11 |    </rect>
 12 |   </property>
 13 |   <layout class="QGridLayout" name="gridLayout">
 14 |    <item row="1" column="0">
 15 |     <widget class="QLabel" name="menu_label">
 16 |      <property name="minimumSize">
 17 |       <size>
 18 |        <width>150</width>
 19 |        <height>0</height>
 20 |       </size>
 21 |      </property>
 22 |      <property name="maximumSize">
 23 |       <size>
 24 |        <width>16777215</width>
 25 |        <height>16777215</height>
 26 |       </size>
 27 |      </property>
 28 |      <property name="text">
 29 |       <string>Menu</string>
 30 |      </property>
 31 |      <property name="alignment">
 32 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
 33 |      </property>
 34 |     </widget>
 35 |    </item>
 36 |    <item row="1" column="1">
 37 |     <widget class="QComboBox" name="menu_location">
 38 |      <property name="toolTip">
 39 |       <string>Choose the main menu where your plugin will reside</string>
 40 |      </property>
 41 |      <item>
 42 |       <property name="text">
 43 |        <string>Plugins</string>
 44 |       </property>
 45 |      </item>
 46 |      <item>
 47 |       <property name="text">
 48 |        <string>Database</string>
 49 |       </property>
 50 |      </item>
 51 |      <item>
 52 |       <property name="text">
 53 |        <string>Raster</string>
 54 |       </property>
 55 |      </item>
 56 |      <item>
 57 |       <property name="text">
 58 |        <string>Vector</string>
 59 |       </property>
 60 |      </item>
 61 |      <item>
 62 |       <property name="text">
 63 |        <string>Web</string>
 64 |       </property>
 65 |      </item>
 66 |     </widget>
 67 |    </item>
 68 |    <item row="0" column="1">
 69 |     <widget class="QLineEdit" name="menu_text">
 70 |      <property name="minimumSize">
 71 |       <size>
 72 |        <width>300</width>
 73 |        <height>0</height>
 74 |       </size>
 75 |      </property>
 76 |      <property name="maximumSize">
 77 |       <size>
 78 |        <width>16777215</width>
 79 |        <height>16777215</height>
 80 |       </size>
 81 |      </property>
 82 |      <property name="toolTip">
 83 |       <string>This is the text that will appear in the menu under your Plugin
 84 | name e.g. Link photos to points.</string>
 85 |      </property>
 86 |      <property name="text">
 87 |       <string/>
 88 |      </property>
 89 |      <property name="placeholderText">
 90 |       <string>e.g. Link photos to points</string>
 91 |      </property>
 92 |     </widget>
 93 |    </item>
 94 |    <item row="3" column="0">
 95 |     <spacer name="verticalSpacer">
 96 |      <property name="orientation">
 97 |       <enum>Qt::Vertical</enum>
 98 |      </property>
 99 |      <property name="sizeHint" stdset="0">
100 |       <size>
101 |        <width>20</width>
102 |        <height>30</height>
103 |       </size>
104 |      </property>
105 |     </spacer>
106 |    </item>
107 |    <item row="0" column="0">
108 |     <widget class="QLabel" name="menu_text_label">
109 |      <property name="minimumSize">
110 |       <size>
111 |        <width>150</width>
112 |        <height>0</height>
113 |       </size>
114 |      </property>
115 |      <property name="maximumSize">
116 |       <size>
117 |        <width>16777215</width>
118 |        <height>16777215</height>
119 |       </size>
120 |      </property>
121 |      <property name="text">
122 |       <string>Text for the menu item</string>
123 |      </property>
124 |      <property name="alignment">
125 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
126 |      </property>
127 |      <property name="buddy">
128 |       <cstring>menu_text</cstring>
129 |      </property>
130 |     </widget>
131 |    </item>
132 |    <item row="2" column="1">
133 |     <widget class="QComboBox" name="dockwidget_area">
134 |      <item>
135 |       <property name="text">
136 |        <string>Left</string>
137 |       </property>
138 |      </item>
139 |      <item>
140 |       <property name="text">
141 |        <string>Right</string>
142 |       </property>
143 |      </item>
144 |      <item>
145 |       <property name="text">
146 |        <string>Top</string>
147 |       </property>
148 |      </item>
149 |      <item>
150 |       <property name="text">
151 |        <string>Bottom</string>
152 |       </property>
153 |      </item>
154 |     </widget>
155 |    </item>
156 |    <item row="2" column="0">
157 |     <widget class="QLabel" name="label">
158 |      <property name="text">
159 |       <string>DockWidget Area</string>
160 |      </property>
161 |      <property name="alignment">
162 |       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
163 |      </property>
164 |     </widget>
165 |    </item>
166 |   </layout>
167 |  </widget>
168 |  <resources/>
169 |  <connections/>
170 | </ui>
171 | 


--------------------------------------------------------------------------------
/qgis_dirs.py:
--------------------------------------------------------------------------------
 1 | """ Get the deployment directory for QGIS plugins based on operating system"""
 2 | import os
 3 | import platform
 4 | 
 5 | # Standard deployment locations
 6 | qgis_dir_location = {'Linux': '.local/share/QGIS/QGIS3/profiles/default/python/plugins/',
 7 |                      'Windows': 'AppData/Roaming/QGIS/QGIS3/profiles/default/python/plugins',
 8 |                      'Darwin': 'Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins'}
 9 | 
10 | # Deployment directory based on users operating system
11 | deployment_dir = os.path.join(
12 |     os.environ['HOME'],
13 |     qgis_dir_location[platform.system()]
14 |     )
15 | 


--------------------------------------------------------------------------------
/resources.qrc:
--------------------------------------------------------------------------------
1 | <RCC>
2 |   <qresource prefix="/plugins/plugin_builder" >
3 |     <file>icon.png</file>
4 |   </qresource>
5 | </RCC>
6 | 
7 | 


--------------------------------------------------------------------------------
/result_dialog.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """
 3 | /***************************************************************************
 4 |     ResultDialog
 5 | 
 6 |     Creates a skeleton QGIS plugin for use as a starting point
 7 |                              -------------------
 8 |         begin                : 2011-01-20
 9 |         git sha              : $Format:%H$
10 |         copyright            : (C) 2011-2014 by GeoApt LLC
11 |         email                : gsherman@geoapt.com
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 | """
23 | 
24 | import os
25 | 
26 | from qgis.PyQt import QtGui, QtWidgets, uic
27 | 
28 | FORM_CLASS, _ = uic.loadUiType(os.path.join(
29 |     os.path.dirname(__file__), 'results_dialog_base.ui'))
30 | 
31 | 
32 | class ResultDialog(QtWidgets.QDialog, FORM_CLASS):
33 |     """Dialog for showing the results of the plugin creation process."""
34 |     def __init__(self, parent=None):
35 |         super(ResultDialog, self).__init__(parent)
36 |         # Set up the user interface from Designer.
37 |         self.setupUi(self)
38 | 


--------------------------------------------------------------------------------
/results_dialog_base.ui:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <ui version="4.0">
 3 |  <class>ResultsDialogBase</class>
 4 |  <widget class="QDialog" name="ResultsDialogBase">
 5 |   <property name="geometry">
 6 |    <rect>
 7 |     <x>0</x>
 8 |     <y>0</y>
 9 |     <width>780</width>
10 |     <height>670</height>
11 |    </rect>
12 |   </property>
13 |   <property name="windowTitle">
14 |    <string>Plugin Builder Results</string>
15 |   </property>
16 |   <layout class="QGridLayout" name="gridLayout">
17 |    <item row="1" column="0">
18 |     <widget class="QDialogButtonBox" name="buttonBox">
19 |      <property name="orientation">
20 |       <enum>Qt::Horizontal</enum>
21 |      </property>
22 |      <property name="standardButtons">
23 |       <set>QDialogButtonBox::Ok</set>
24 |      </property>
25 |     </widget>
26 |    </item>
27 |    <item row="0" column="0">
28 |     <widget class="QTextBrowser" name="web_view"/>
29 |    </item>
30 |   </layout>
31 |  </widget>
32 |  <resources/>
33 |  <connections>
34 |   <connection>
35 |    <sender>buttonBox</sender>
36 |    <signal>accepted()</signal>
37 |    <receiver>ResultsDialogBase</receiver>
38 |    <slot>accept()</slot>
39 |    <hints>
40 |     <hint type="sourcelabel">
41 |      <x>248</x>
42 |      <y>254</y>
43 |     </hint>
44 |     <hint type="destinationlabel">
45 |      <x>157</x>
46 |      <y>274</y>
47 |     </hint>
48 |    </hints>
49 |   </connection>
50 |   <connection>
51 |    <sender>buttonBox</sender>
52 |    <signal>rejected()</signal>
53 |    <receiver>ResultsDialogBase</receiver>
54 |    <slot>reject()</slot>
55 |    <hints>
56 |     <hint type="sourcelabel">
57 |      <x>316</x>
58 |      <y>260</y>
59 |     </hint>
60 |     <hint type="destinationlabel">
61 |      <x>286</x>
62 |      <y>274</y>
63 |     </hint>
64 |    </hints>
65 |   </connection>
66 |  </connections>
67 | </ui>
68 | 


--------------------------------------------------------------------------------
/run-env-linux.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # Tim Sutton 2014
 4 | # git sha : $Format:%H$
 5 | 
 6 | QGIS_PREFIX_PATH=/usr/local/qgis-2.0
 7 | if [ -n "$1" ]; then
 8 |     QGIS_PREFIX_PATH=$1
 9 | fi
10 | 
11 | echo ${QGIS_PREFIX_PATH}
12 | 
13 | 
14 | export QGIS_PREFIX_PATH=${QGIS_PREFIX_PATH}
15 | export QGIS_PATH=${QGIS_PREFIX_PATH}
16 | export LD_LIBRARY_PATH=${QGIS_PREFIX_PATH}/lib
17 | export PYTHONPATH=${QGIS_PREFIX_PATH}/share/qgis/python:${QGIS_PREFIX_PATH}/share/qgis/python/plugins:${PYTHONPATH}
18 | 
19 | echo "QGIS PATH: ${QGIS_PREFIX_PATH}"
20 | export QGIS_DEBUG=0
21 | export QGIS_LOG_FILE=/tmp/inasafe/realtime/logs/qgis.log
22 | 
23 | export PATH=${QGIS_PREFIX_PATH}/bin:$PATH
24 | 
25 | echo "This script is intended to be sourced to set up your shell to"
26 | echo "use a QGIS 2.0 built in $QGIS_PREFIX_PATH"
27 | echo
28 | echo "To use it do:"
29 | echo "source $BASH_SOURCE /your/optional/install/path"
30 | echo
31 | echo "Then use the make file supplied here e.g. make guitest"
32 | 


--------------------------------------------------------------------------------
/select_tags_dialog.py:
--------------------------------------------------------------------------------
 1 | # coding=utf-8
 2 | """
 3 | /***************************************************************************
 4 |     SelectTagsDialog
 5 | 
 6 |     Creates a skeleton QGIS plugin for use as a starting point
 7 |                              -------------------
 8 |         begin                : 2011-01-20
 9 |         git sha              : $Format:%H$
10 |         copyright            : (C) 2011-2014 by GeoApt LLC
11 |         email                : gsherman@geoapt.com
12 |  ***************************************************************************/
13 | 
14 | /***************************************************************************
15 |  *                                                                         *
16 |  *   This program is free software; you can redistribute it and/or modify  *
17 |  *   it under the terms of the GNU General Public License as published by  *
18 |  *   the Free Software Foundation; either version 2 of the License, or     *
19 |  *   (at your option) any later version.                                   *
20 |  *                                                                         *
21 |  ***************************************************************************/
22 | """
23 | 
24 | import os
25 | 
26 | from qgis.PyQt import QtGui, QtWidgets, uic
27 | 
28 | FORM_CLASS, _ = uic.loadUiType(os.path.join(
29 |     os.path.dirname(__file__), 'select_tags_dialog_base.ui'))
30 | 
31 | 
32 | class SelectTagsDialog(QtWidgets.QDialog, FORM_CLASS):
33 |     """Dialog for selecting one or more tags for the plugin."""
34 |     def __init__(self, parent=None):
35 |         super(SelectTagsDialog, self).__init__(parent)
36 |         # Set up the user interface from Designer.
37 |         self.setupUi(self)
38 | 


--------------------------------------------------------------------------------
/select_tags_dialog_base.ui:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <ui version="4.0">
 3 |  <class>dlgSelectTags</class>
 4 |  <widget class="QDialog" name="dlgSelectTags">
 5 |   <property name="geometry">
 6 |    <rect>
 7 |     <x>0</x>
 8 |     <y>0</y>
 9 |     <width>320</width>
10 |     <height>384</height>
11 |    </rect>
12 |   </property>
13 |   <property name="windowTitle">
14 |    <string>Select Tags</string>
15 |   </property>
16 |   <layout class="QGridLayout" name="gridLayout">
17 |    <item row="0" column="0">
18 |     <widget class="QLabel" name="label">
19 |      <property name="text">
20 |       <string>Select one or more tags</string>
21 |      </property>
22 |     </widget>
23 |    </item>
24 |    <item row="1" column="0">
25 |     <widget class="QListView" name="listView">
26 |      <property name="selectionMode">
27 |       <enum>QAbstractItemView::MultiSelection</enum>
28 |      </property>
29 |      <property name="selectionBehavior">
30 |       <enum>QAbstractItemView::SelectItems</enum>
31 |      </property>
32 |     </widget>
33 |    </item>
34 |    <item row="2" column="0">
35 |     <widget class="QDialogButtonBox" name="buttonBox">
36 |      <property name="orientation">
37 |       <enum>Qt::Horizontal</enum>
38 |      </property>
39 |      <property name="standardButtons">
40 |       <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
41 |      </property>
42 |     </widget>
43 |    </item>
44 |   </layout>
45 |  </widget>
46 |  <resources/>
47 |  <connections>
48 |   <connection>
49 |    <sender>buttonBox</sender>
50 |    <signal>accepted()</signal>
51 |    <receiver>dlgSelectTags</receiver>
52 |    <slot>accept()</slot>
53 |    <hints>
54 |     <hint type="sourcelabel">
55 |      <x>248</x>
56 |      <y>254</y>
57 |     </hint>
58 |     <hint type="destinationlabel">
59 |      <x>157</x>
60 |      <y>274</y>
61 |     </hint>
62 |    </hints>
63 |   </connection>
64 |   <connection>
65 |    <sender>buttonBox</sender>
66 |    <signal>rejected()</signal>
67 |    <receiver>dlgSelectTags</receiver>
68 |    <slot>reject()</slot>
69 |    <hints>
70 |     <hint type="sourcelabel">
71 |      <x>316</x>
72 |      <y>260</y>
73 |     </hint>
74 |     <hint type="destinationlabel">
75 |      <x>286</x>
76 |      <y>274</y>
77 |     </hint>
78 |    </hints>
79 |   </connection>
80 |  </connections>
81 | </ui>
82 | 


--------------------------------------------------------------------------------
/taglist.txt:
--------------------------------------------------------------------------------
 1 | analysis
 2 | animation
 3 | attribute
 4 | attribute edit
 5 | attribute table
 6 | bing
 7 | cad
 8 | cadastre
 9 | calculator
10 | centroid
11 | circle
12 | composer
13 | csv
14 | database
15 | delimitation
16 | dem
17 | digitizing
18 | distance
19 | ecology
20 | editing
21 | export
22 | feature
23 | field
24 | flood
25 | flow
26 | geocoding
27 | geojson
28 | geometry
29 | google
30 | home range
31 | html
32 | hydraulics
33 | import
34 | inspire
35 | intersection
36 | join
37 | kmz
38 | labeling
39 | land cover
40 | landsat
41 | landscape
42 | layers
43 | legend
44 | line
45 | mask
46 | metadata
47 | network
48 | network analysis
49 | openlayers
50 | openstreetmap
51 | ordnance survey
52 | osm
53 | pdf
54 | point
55 | polygon
56 | polyline
57 | postgis
58 | print
59 | processing
60 | profile
61 | project
62 | raster
63 | rectangle
64 | remote sensing
65 | routing
66 | search
67 | select
68 | shapefile
69 | spatial join
70 | spatialite
71 | statistics
72 | streetview
73 | style
74 | table
75 | tiles
76 | time
77 | tms
78 | topography
79 | translate
80 | transparency
81 | vector
82 | web
83 | webservice
84 | wfs
85 | wkt
86 | wms
87 | 


--------------------------------------------------------------------------------
/test/__init__.py:
--------------------------------------------------------------------------------
1 | __author__ = 'timlinux'
2 | 


--------------------------------------------------------------------------------
/test/qgis_interface.py:
--------------------------------------------------------------------------------
  1 | # coding=utf-8
  2 | """QGIS plugin implementation.
  3 | 
  4 | .. note:: This program is free software; you can redistribute it and/or modify
  5 |      it under the terms of the GNU General Public License as published by
  6 |      the Free Software Foundation; either version 2 of the License, or
  7 |      (at your option) any later version.
  8 | 
  9 |      NOTE: This file is duplicated in the plugin template - figure out how
 10 |      to have only one copy in this source tree.
 11 | 
 12 | .. note:: This source code was copied from the 'postgis viewer' application
 13 |      with original authors:
 14 |      Copyright (c) 2010 by Ivan Mincik, ivan.mincik@gista.sk
 15 |      Copyright (c) 2011 German Carrillo, geotux_tuxman@linuxmail.org
 16 |      Copyright (c) 2014 Tim Sutton, tim@linfiniti.com
 17 | 
 18 | """
 19 | 
 20 | __author__ = 'tim@linfiniti.com'
 21 | __revision__ = '$Format:%H$'
 22 | __date__ = '10/01/2011'
 23 | __copyright__ = (
 24 |     'Copyright (c) 2010 by Ivan Mincik, ivan.mincik@gista.sk and '
 25 |     'Copyright (c) 2011 German Carrillo, geotux_tuxman@linuxmail.org'
 26 |     'Copyright (c) 2014 Tim Sutton, tim@linfiniti.com'
 27 | )
 28 | 
 29 | import logging
 30 | from qgis.PyQt.QtCore import QObject, pyqtSlot, pyqtSignal
 31 | from qgis.core import QgsMapLayerRegistry
 32 | from qgis.gui import QgsMapCanvasLayer
 33 | LOGGER = logging.getLogger('InaSAFE')
 34 | 
 35 | 
 36 | #noinspection PyMethodMayBeStatic,PyPep8Naming
 37 | class QgisInterface(QObject):
 38 |     """Class to expose QGIS objects and functions to plugins.
 39 | 
 40 |     This class is here for enabling us to run unit tests only,
 41 |     so most methods are simply stubs.
 42 |     """
 43 |     currentLayerChanged = pyqtSignal(QgsMapCanvasLayer)
 44 | 
 45 |     def __init__(self, canvas):
 46 |         """Constructor
 47 |         :param canvas:
 48 |         """
 49 |         QObject.__init__(self)
 50 |         self.canvas = canvas
 51 |         # Set up slots so we can mimic the behaviour of QGIS when layers
 52 |         # are added.
 53 |         LOGGER.debug('Initialising canvas...')
 54 |         # noinspection PyArgumentList
 55 |         QgsMapLayerRegistry.instance().layersAdded.connect(self.addLayers)
 56 |         # noinspection PyArgumentList
 57 |         QgsMapLayerRegistry.instance().layerWasAdded.connect(self.addLayer)
 58 |         # noinspection PyArgumentList
 59 |         QgsMapLayerRegistry.instance().removeAll.connect(self.removeAllLayers)
 60 | 
 61 |         # For processing module
 62 |         self.destCrs = None
 63 | 
 64 |     @pyqtSlot('QStringList')
 65 |     def addLayers(self, layers):
 66 |         """Handle layers being added to the registry so they show up in canvas.
 67 | 
 68 |         :param layers: list<QgsMapLayer> list of map layers that were added
 69 | 
 70 |         .. note:: The QgsInterface api does not include this method,
 71 |             it is added here as a helper to facilitate testing.
 72 |         """
 73 |         #LOGGER.debug('addLayers called on qgis_interface')
 74 |         #LOGGER.debug('Number of layers being added: %s' % len(layers))
 75 |         #LOGGER.debug('Layer Count Before: %s' % len(self.canvas.layers()))
 76 |         current_layers = self.canvas.layers()
 77 |         final_layers = []
 78 |         for layer in current_layers:
 79 |             final_layers.append(QgsMapCanvasLayer(layer))
 80 |         for layer in layers:
 81 |             final_layers.append(QgsMapCanvasLayer(layer))
 82 | 
 83 |         self.canvas.setLayerSet(final_layers)
 84 |         #LOGGER.debug('Layer Count After: %s' % len(self.canvas.layers()))
 85 | 
 86 |     @pyqtSlot('QgsMapLayer')
 87 |     def addLayer(self, layer):
 88 |         """Handle a layer being added to the registry so it shows up in canvas.
 89 | 
 90 |         :param layer: list<QgsMapLayer> list of map layers that were added
 91 | 
 92 |         .. note: The QgsInterface api does not include this method, it is added
 93 |                  here as a helper to facilitate testing.
 94 | 
 95 |         .. note: The addLayer method was deprecated in QGIS 1.8 so you should
 96 |                  not need this method much.
 97 |         """
 98 |         pass
 99 | 
100 |     @pyqtSlot()
101 |     def removeAllLayers(self):
102 |         """Remove layers from the canvas before they get deleted."""
103 |         self.canvas.setLayerSet([])
104 | 
105 |     def newProject(self):
106 |         """Create new project."""
107 |         # noinspection PyArgumentList
108 |         QgsMapLayerRegistry.instance().removeAllMapLayers()
109 | 
110 |     # ---------------- API Mock for QgsInterface follows -------------------
111 | 
112 |     def zoomFull(self):
113 |         """Zoom to the map full extent."""
114 |         pass
115 | 
116 |     def zoomToPrevious(self):
117 |         """Zoom to previous view extent."""
118 |         pass
119 | 
120 |     def zoomToNext(self):
121 |         """Zoom to next view extent."""
122 |         pass
123 | 
124 |     def zoomToActiveLayer(self):
125 |         """Zoom to extent of active layer."""
126 |         pass
127 | 
128 |     def addVectorLayer(self, path, base_name, provider_key):
129 |         """Add a vector layer.
130 | 
131 |         :param path: Path to layer.
132 |         :type path: str
133 | 
134 |         :param base_name: Base name for layer.
135 |         :type base_name: str
136 | 
137 |         :param provider_key: Provider key e.g. 'ogr'
138 |         :type provider_key: str
139 |         """
140 |         pass
141 | 
142 |     def addRasterLayer(self, path, base_name):
143 |         """Add a raster layer given a raster layer file name
144 | 
145 |         :param path: Path to layer.
146 |         :type path: str
147 | 
148 |         :param base_name: Base name for layer.
149 |         :type base_name: str
150 |         """
151 |         pass
152 | 
153 |     def activeLayer(self):
154 |         """Get pointer to the active layer (layer selected in the legend)."""
155 |         # noinspection PyArgumentList
156 |         layers = QgsMapLayerRegistry.instance().mapLayers()
157 |         for item in layers:
158 |             return layers[item]
159 | 
160 |     def addToolBarIcon(self, action):
161 |         """Add an icon to the plugins toolbar.
162 | 
163 |         :param action: Action to add to the toolbar.
164 |         :type action: QAction
165 |         """
166 |         pass
167 | 
168 |     def removeToolBarIcon(self, action):
169 |         """Remove an action (icon) from the plugin toolbar.
170 | 
171 |         :param action: Action to add to the toolbar.
172 |         :type action: QAction
173 |         """
174 |         pass
175 | 
176 |     def addToolBar(self, name):
177 |         """Add toolbar with specified name.
178 | 
179 |         :param name: Name for the toolbar.
180 |         :type name: str
181 |         """
182 |         pass
183 | 
184 |     def mapCanvas(self):
185 |         """Return a pointer to the map canvas."""
186 |         return self.canvas
187 | 
188 |     def mainWindow(self):
189 |         """Return a pointer to the main window.
190 | 
191 |         In case of QGIS it returns an instance of QgisApp.
192 |         """
193 |         pass
194 | 
195 |     def addDockWidget(self, area, dock_widget):
196 |         """Add a dock widget to the main window.
197 | 
198 |         :param area: Where in the ui the dock should be placed.
199 |         :type area:
200 | 
201 |         :param dock_widget: A dock widget to add to the UI.
202 |         :type dock_widget: QDockWidget
203 |         """
204 |         pass
205 | 
206 |     def legendInterface(self):
207 |         """Get the legend."""
208 |         return self.canvas
209 | 


--------------------------------------------------------------------------------
/test/test_builder.py:
--------------------------------------------------------------------------------
  1 | __author__ = 'timlinux'
  2 | 
  3 | # coding=utf-8
  4 | """
  5 | InaSAFE Disaster risk assessment tool developed by AusAid -
  6 | **ISClipper test suite.**
  7 | 
  8 | Contact : ole.moller.nielsen@gmail.com
  9 | 
 10 | .. note:: This program is free software; you can redistribute it and/or modify
 11 |      it under the terms of the GNU General Public License as published by
 12 |      the Free Software Foundation; either version 2 of the License, or
 13 |      (at your option) any later version.
 14 | 
 15 | """
 16 | 
 17 | 
 18 | __author__ = 'tim@linfiniti.com'
 19 | __date__ = '20/01/2011'
 20 | __copyright__ = ('Copyright 2012, Australia Indonesia Facility for '
 21 |                  'Disaster Reduction')
 22 | 
 23 | import os
 24 | import unittest
 25 | 
 26 | from qgis.core import QgsProviderRegistry
 27 | 
 28 | 
 29 | from test.utilities import get_qgis_app
 30 | from .utilities import temp_dir, unique_filename
 31 | 
 32 | QGIS_APP = get_qgis_app()
 33 | 
 34 | from plugin_builder import PluginBuilder, copy
 35 | from .qgis_interface import QgisInterface
 36 | 
 37 | 
 38 | class FakePluginSpecification(object):
 39 |     """A fake of PluginSpecification for testing."""
 40 |     def __init__(self):
 41 |         """Constructor.
 42 | 
 43 |         After calling the constructor, the class properties
 44 |         self.template_map, self.experimental etc. will be set.
 45 | 
 46 |         """
 47 |         self.class_name = 'FakePlugin'
 48 |         self.author = 'Fake Author'
 49 |         self.description = 'Fake Description'
 50 |         self.module_name = 'fake_module'
 51 |         self.email_address = 'fake@mail.com'
 52 |         self.menu_text = 'Fake Menu'
 53 |         self.qgis_minimum_version = '2.0.0'
 54 |         self.title = 'A fake plugin'
 55 |         self.plugin_version = '1.0.0'
 56 |         self.homepage = 'http://fakeqgisplugin.com'
 57 |         self.tracker = 'http://github.com/timlinux/fakeplugin/issues'
 58 |         self.repository = 'http://github.com/timlinux/fakeplugin/'
 59 |         self.tags = 'fake, qgis, plugin'
 60 |         # icon selection from disk will be added at a later version
 61 |         self.icon = 'icon.png'
 62 |         self.experimental = False
 63 |         # Builder flags
 64 |         self.gen_i18n = True
 65 |         self.gen_help = True
 66 |         self.gen_tests = True
 67 |         self.gen_scripts = True
 68 |         self.gen_makefile = True
 69 |         self.gen_pb_tool = True
 70 |         # deprecated is always false for a new plugin
 71 |         self.deprecated = False
 72 |         self.build_year = 2001
 73 |         self.build_date = '31-01-2014'
 74 |         # Git will replace this with the sha - I do it a funny way below so
 75 |         # that this line below does not itself get substituted by git!
 76 |         self.vcs_format = '$Format:' + '%H$'
 77 | 
 78 |         self.template_map = {
 79 |             'TemplateClass': self.class_name,
 80 |             'TemplateTitle': self.title,
 81 |             'TemplateDescription': self.description,
 82 |             'TemplateModuleName': self.module_name,
 83 |             'TemplateVersion': self.plugin_version,
 84 |             'TemplateQgisVersion': self.qgis_minimum_version,
 85 |             'TemplateAuthor': self.author,
 86 |             'TemplateEmail': self.email_address,
 87 |             'PluginDirectoryName': self.class_name.lower(),
 88 |             'TemplateBuildDate': self.build_date,
 89 |             'TemplateYear': self.build_year,
 90 |             'TemplateVCSFormat': self.vcs_format,
 91 |             # Makefile
 92 |             'TemplatePyFiles': '%s_dialog.py' % self.module_name,
 93 |             'TemplateUiFiles': '%s_dialog_base.ui' % self.module_name,
 94 |             'TemplateExtraFiles': 'icon.png',
 95 |             'TemplateQrcFiles': 'resources.qrc',
 96 |             'TemplateRcFiles': "resources.py",
 97 |             # Menu
 98 |             'TemplateMenuText': self.menu_text,
 99 |             'TemplateMenuAddMethod': 'addPluginToMenu',
100 |             'TemplateMenuRemoveMethod': 'removePluginMenu'
101 |         }
102 | 
103 | 
104 | class QGISTest(unittest.TestCase):
105 |     """Test the QGIS Environment"""
106 | 
107 |     def test_qgis_environment(self):
108 |         """QGIS environment has the expected providers"""
109 | 
110 |         registry = QgsProviderRegistry.instance()
111 |         self.assertIn('gdal', registry.providerList())
112 |         self.assertIn('ogr', registry.providerList())
113 |         self.assertIn('postgres', registry.providerList())
114 | 
115 | 
116 | class BuilderTest(unittest.TestCase):
117 |     """Test the plugin builder."""
118 | 
119 |     def __init__(self, *args, **kwargs):
120 |         super(BuilderTest, self).__init__(*args, **kwargs)
121 |         # Define class members here....
122 |         self.shared_dir = None
123 |         self.template_dir = None
124 |         self.specification = FakePluginSpecification()
125 | 
126 |     def setUp(self):
127 |         """Setup run before each test."""
128 |         self.shared_dir = os.path.abspath(os.path.join(
129 |             os.path.dirname(__file__), '..', 'plugin_templates', 'shared'))
130 |         self.template_dir = os.path.abspath(os.path.join(
131 |             os.path.dirname(__file__), '..', 'plugin_templates',
132 |             'toolbutton_with_dialog', 'template'))
133 | 
134 |     def test_dir_copy(self):
135 |         """Test that we can copy a directory of files.
136 | 
137 |         Path to copy to must not pre-exist so we create a parent dir
138 |         and generate a temp dir name without actually creating it.
139 |         """
140 | 
141 |         temp_path = temp_dir()
142 |         temp_name = unique_filename(prefix='plugin_builder_')
143 |         new_path = os.path.join(temp_path, temp_name)
144 |         copy(os.path.join(self.shared_dir, 'test'), new_path)
145 |         test_file_path = os.path.join(new_path, 'test_init.py')
146 |         self.assertTrue(os.path.exists(test_file_path), test_file_path)
147 | 
148 |     def test_prepare_code(self):
149 |         """Test the prepare code helper works."""
150 |         temp_path = temp_dir()
151 |         iface = QgisInterface(None)
152 |         builder = PluginBuilder(iface)
153 |         builder.shared_dir = self.shared_dir
154 |         builder.template_dir = self.template_dir
155 |         builder.plugin_path = temp_path
156 |         builder._prepare_code(self.specification)
157 | 
158 |     def test_prepare_results_html(self):
159 |         """Test the prepare results helper works."""
160 |         temp_path = temp_dir()
161 |         iface = QgisInterface(None)
162 |         builder = PluginBuilder(iface)
163 |         builder.shared_dir = self.shared_dir
164 |         builder.template_dir = self.template_dir
165 |         builder.plugin_path = temp_path
166 |         results_popped, template_module_name = builder._prepare_results_html(
167 |             self.specification)
168 |         self.assertIn('You just built a plugin for QGIS!', results_popped)
169 |         self.assertEqual(template_module_name, 'fake_module')
170 | 
171 |     def test_prepare_readme(self):
172 |         """Test we can generate the readme ok."""
173 |         temp_path = temp_dir()
174 |         iface = QgisInterface(None)
175 |         builder = PluginBuilder(iface)
176 |         builder.shared_dir = self.shared_dir
177 |         builder.template_dir = self.template_dir
178 |         builder.plugin_path = temp_path
179 |         builder._prepare_readme(self.specification, 'fake_module')
180 |         # TODO: go and look in the file and see if it is ok
181 | 
182 |     def test_prepare_metadata(self):
183 |         """Test we can generate the metadata."""
184 |         temp_path = temp_dir()
185 |         iface = QgisInterface(None)
186 |         builder = PluginBuilder(iface)
187 |         builder.shared_dir = self.shared_dir
188 |         builder.template_dir = self.template_dir
189 |         builder.plugin_path = temp_path
190 |         builder._prepare_results_html(self.specification)
191 |         # TODO: go and look in the file and see if it is ok
192 | 


--------------------------------------------------------------------------------
/test/utilities.py:
--------------------------------------------------------------------------------
  1 | # coding=utf-8
  2 | """Utilities for testing.
  3 | 
  4 | Note: Shameless duplication exists here with what is in the
  5 | template plugin file structure. Figure out how to have DRY.
  6 | 
  7 | Tim Sutton
  8 | """
  9 | 
 10 | import getpass
 11 | import os
 12 | import sys
 13 | import logging
 14 | from datetime import date
 15 | from tempfile import mkstemp
 16 | 
 17 | LOGGER = logging.getLogger('QGIS')
 18 | QGIS_APP = None  # Static variable used to hold hand to running QGIS app
 19 | CANVAS = None
 20 | PARENT = None
 21 | IFACE = None
 22 | 
 23 | 
 24 | def get_qgis_app():
 25 |     """ Start one QGIS application to test against.
 26 | 
 27 |     :returns: Handle to QGIS app, canvas, iface and parent. If there are any
 28 |         errors the tuple members will be returned as None.
 29 |     :rtype: (QgsApplication, CANVAS, IFACE, PARENT)
 30 | 
 31 |     If QGIS is already running the handle to that app will be returned.
 32 |     """
 33 | 
 34 |     try:
 35 |         from qgis.PyQt import QtGui, QtCore
 36 |         from qgis.core import QgsApplication
 37 |         from qgis.gui import QgsMapCanvas
 38 |         from .qgis_interface import QgisInterface
 39 |     except ImportError:
 40 |         return None, None, None, None
 41 | 
 42 |     global QGIS_APP  # pylint: disable=W0603
 43 | 
 44 |     if QGIS_APP is None:
 45 |         gui_flag = True  # All test will run qgis in gui mode
 46 |         #noinspection PyPep8Naming
 47 |         QGIS_APP = QgsApplication(sys.argv, gui_flag)
 48 |         # Make sure QGIS_PREFIX_PATH is set in your env if needed!
 49 |         QGIS_APP.initQgis()
 50 |         s = QGIS_APP.showSettings()
 51 |         LOGGER.debug(s)
 52 | 
 53 |     global PARENT  # pylint: disable=W0603
 54 |     if PARENT is None:
 55 |         #noinspection PyPep8Naming
 56 |         PARENT = QtGui.QWidget()
 57 | 
 58 |     global CANVAS  # pylint: disable=W0603
 59 |     if CANVAS is None:
 60 |         #noinspection PyPep8Naming
 61 |         CANVAS = QgsMapCanvas(PARENT)
 62 |         CANVAS.resize(QtCore.QSize(400, 400))
 63 | 
 64 |     global IFACE  # pylint: disable=W0603
 65 |     if IFACE is None:
 66 |         # QgisInterface is a stub implementation of the QGIS plugin interface
 67 |         #noinspection PyPep8Naming
 68 |         IFACE = QgisInterface(CANVAS)
 69 | 
 70 |     return QGIS_APP, CANVAS, IFACE, PARENT
 71 | 
 72 | 
 73 | def temp_dir(sub_dir='work'):
 74 |     """Obtain the temporary working directory for the operating system.
 75 | 
 76 |     .. note:: Taken from InaSAFE:
 77 |          https://github.com/AIFDR/inasafe/blob/master/safe/common/utilities.py
 78 | 
 79 |     An inasafe subdirectory will automatically be created under this and
 80 |     if specified, a user subdirectory under that.
 81 | 
 82 |     .. note:: You can use this together with unique_filename to create
 83 |        a file in a temporary directory under the inasafe workspace. e.g.
 84 | 
 85 |        tmpdir = temp_dir('testing')
 86 |        tmpfile = unique_filename(dir=tmpdir)
 87 |        print tmpfile
 88 |        /tmp/inasafe/23-08-2012/timlinux/testing/tmpMRpF_C
 89 | 
 90 |     If you specify INASAFE_WORK_DIR as an environment var, it will be
 91 |     used in preference to the system temp directory.
 92 | 
 93 |     :param sub_dir: Optional argument which will cause an additional
 94 |         subdirectory to be created e.g. /tmp/inasafe/foo/
 95 |     :type sub_dir: str
 96 | 
 97 |     :return: Path to the output clipped layer (placed in the system temp dir).
 98 |     :rtype: str
 99 | 
100 |     :raises: Any errors from the underlying system calls.
101 |     """
102 |     user = getpass.getuser().replace(' ', '_')
103 |     current_date = date.today()
104 |     date_string = current_date.isoformat()
105 | 
106 |     # Following 4 lines are a workaround for tempfile.tempdir() unreliabilty
107 |     handle, filename = mkstemp()
108 |     os.close(handle)
109 |     new_directory = os.path.dirname(filename)
110 |     os.remove(filename)
111 | 
112 |     path = os.path.join(
113 |         new_directory, 'pluginbuilder', date_string, user, sub_dir)
114 | 
115 |     if not os.path.exists(path):
116 |         # Ensure that the dir is world writable
117 |         # Umask sets the new mask and returns the old
118 |         old_mask = os.umask(0000)
119 |         os.makedirs(path, 0o777)
120 |         # Reinstate the old mask for tmp
121 |         os.umask(old_mask)
122 |     return path
123 | 
124 | 
125 | def unique_filename(**kwargs):
126 |     """Create new filename guaranteed not to exist previously
127 | 
128 |     Use mkstemp to create the file, then remove it and return the name
129 | 
130 |     If dir is specified, the tempfile will be created in the path specified
131 |     otherwise the file will be created in a directory following this scheme:
132 | 
133 |     :file:'/tmp/inasafe/<dd-mm-yyyy>/<user>/impacts'
134 | 
135 |     See http://docs.python.org/library/tempfile.html for details.
136 | 
137 |     Example usage:
138 | 
139 |     tempdir = temp_dir(sub_dir='test')
140 |     filename = unique_filename(suffix='.keywords', dir=tempdir)
141 |     print filename
142 |     /tmp/inasafe/23-08-2012/timlinux/test/tmpyeO5VR.keywords
143 | 
144 |     Or with no preferred subdir, a default subdir of 'impacts' is used:
145 | 
146 |     filename = unique_filename(suffix='.shp')
147 |     print filename
148 |     /tmp/inasafe/23-08-2012/timlinux/impacts/tmpoOAmOi.shp
149 | 
150 |     :param kwargs: Keyword arguments.
151 |     :type kwargs: dict
152 | 
153 |     """
154 | 
155 |     if 'dir' not in kwargs:
156 |         path = temp_dir('impacts')
157 |         kwargs['dir'] = path
158 |     else:
159 |         path = temp_dir(kwargs['dir'])
160 |         kwargs['dir'] = path
161 |     if not os.path.exists(kwargs['dir']):
162 |         # Ensure that the dir mask won't conflict with the mode
163 |         # Umask sets the new mask and returns the old
164 |         umask = os.umask(0000)
165 |         # Ensure that the dir is world writable by explicitly setting mode
166 |         os.makedirs(kwargs['dir'], 0o777)
167 |         # Reinstate the old mask for tmp dir
168 |         os.umask(umask)
169 |     # Now we have the working dir set up go on and return the filename
170 |     handle, filename = mkstemp(**kwargs)
171 | 
172 |     # Need to close it using the file handle first for windows!
173 |     os.close(handle)
174 |     try:
175 |         os.remove(filename)
176 |     except OSError:
177 |         pass
178 |     return filename
179 | 


--------------------------------------------------------------------------------