Merge pull request #15 from Samweli/plugin_dock

Implementation for the main plugin dock

.github/workflows/ci.yml

@@ -3,15 +3,15 @@ name: Continuous Integration
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     types:
       - edited
       - opened
       - reopened
       - synchronize
     branches:
-      - master
+      - main
 
 env:
   # Global environment variable

README.md

@@ -1,7 +1,7 @@
 # QGIS GEA Afforestation tool
 
 
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/kartoza/qgis-gea-plugin/ci.yml?branch=master)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/kartoza/qgis-gea-plugin/ci.yml?branch=main)
 ![GitHub](https://img.shields.io/github/license/kartoza/qgis-gea-plugin)
 
 QGIS plugin description.

config.json

@@ -15,7 +15,7 @@
     "about": "Adds functionality inside QGIS to enable GEA afforestation visualization and analysis.",
     "author": "Kartoza",
     "email": "[email protected]",
-    "description": "QGIS plugin for the GEA afforestation",
+    "description": "View, browse and navigate through imagery.",
     "version": "0.0.1",
     "changelog": ""
   }

docker-compose.yml

@@ -0,0 +1,20 @@
+version: '2.1'
+services:
+  qgis-testing-environment:
+    image: ${IMAGE}:${QGIS_VERSION_TAG}
+    volumes:
+      - ./build/qgis_gea_plugin:/tests_directory:rw
+    environment:
+      QGIS_VERSION_TAG: "${QGIS_VERSION_TAG}"
+      WITH_PYTHON_PEP: "${WITH_PYTHON_PEP}"
+      ON_TRAVIS: "${ON_TRAVIS}"
+      MUTE_LOGS: "${MUTE_LOGS}"
+      DISPLAY: ":99"
+    working_dir: /tests_directory
+    entrypoint: /tests_directory/scripts/docker/qgis-testing-entrypoint.sh
+    # Enable "command:" line below to immediately run unittests upon docker-compose up
+    # command: qgis_testrunner.sh test_suite.test_package
+    # Default behaviour of the container is to standby
+    command: tail -f /dev/null
+    # qgis_testrunner.sh needs tty for tee
+    tty: true

docs/src/about/contributing.md

@@ -93,7 +93,7 @@ through these `document`, `good first issue` and `help wanted` issues:
 
 #### Checkout a branch
 
-* **master**: PR Base branch.
+* **main**: PR Base branch.
 * **production**: lastest release branch with distribution files. Never make a PR on this.
 * **gh-pages**: API docs, examples and demo
 

resources/resources.qrc

@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/plugins/qgis_gea_plugin">
+        <file>icon.png</file>
+    </qresource>
+</RCC>

scripts/docker/qgis-gea-plugin-test-pre-scripts.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+qgis_setup.sh
+
+# FIX default installation because the sources must be in "qgis-gea-plugin" parent folder
+rm -rf  /root/.local/share/QGIS/QGIS3/profiles/default/python/plugins/qgis-gea-plugin
+ln -sf /tests_directory /root/.local/share/QGIS/QGIS3/profiles/default/python/plugins/qgis-gea-plugin
+ln -sf /tests_directory /usr/share/qgis/python/plugins/qgis-gea-plugin

src/qgis_gea_plugin/__init__.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+"""
+/***************************************************************************
+ QgisGea
+
+ A QGIS plugin that enables usage of the GEA afforestation data visualization.
+                             -------------------
+        begin                : 2024-06-27
+        copyright            : (C) 2024 by Kartoza
+        email                : [email protected]
+        git sha              : $Format:%H$
+ ***************************************************************************/
+/***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+ This script initializes the plugin, making it known to QGIS.
+"""
+
+# noinspection PyPep8Naming
+def classFactory(iface):  # pylint: disable=invalid-name
+    """Load QgisCplus class
+    :param iface: A QGIS interface instance.
+    :type iface: QgsInterface
+    """
+    #
+    from .main import QgisGea
+
+    return QgisGea(iface)

src/qgis_gea_plugin/gui/qgis_plugin_template.py → src/qgis_gea_plugin/gui/qgis_gea_plugin.py

@@ -13,27 +13,12 @@
     QtNetwork,
 )
 from qgis.PyQt.uic import loadUiType
-from qgis.core import (
-    Qgis,
-    QgsCoordinateReferenceSystem,
-    QgsGeometry,
-    QgsRectangle,
-    QgsWkbTypes,
-)
-
-from qgis.gui import (
-    QgsMessageBar,
-    QgsMapCanvas,
-    QgsRubberBand,
-)
-
-from qgis.utils import iface
 
 from ..resources import *
 
 
 WidgetUi, _ = loadUiType(
-    os.path.join(os.path.dirname(__file__), "../ui/qgis_gea_plugin.ui")
+    os.path.join(os.path.dirname(__file__), "../ui/main_dockwidget.ui")
 )
 
 
@@ -48,3 +33,11 @@ def __init__(
         super().__init__(parent)
         self.setupUi(self)
         self.iface = iface
+
+        icon_pixmap = QtGui.QPixmap(":/plugins/qgis_gea_plugin/icon.png")
+        self.icon_la.setPixmap(icon_pixmap)
+
+        self.play_btn.setIcon(
+            QtGui.QIcon(":/images/themes/default/mActionPlay.svg")
+        )
+

src/qgis_gea_plugin/main.py

@@ -22,7 +22,7 @@
 from .gui.qgis_gea_plugin import QgisGeaPlugin
 
 
-class QgisPlugin:
+class QgisGea:
     """QGIS GEA Plugin Implementation."""
 
     def __init__(self, iface):
@@ -141,7 +141,7 @@ def add_action(
 
     def initGui(self):
         """Create the menu entries and toolbar icons inside the QGIS GUI."""
-        icon_path = ":/plugins/qgis_gea_plugin/icon.svg"
+        icon_path = ":/plugins/qgis_gea_plugin/icon.png"
         self.add_action(
             icon_path,
             text=self.tr("Open Plugin"),