Add a plugin logo and improve parsing of the CHANGELOG.md file (GeoNo…

…de#216)

fixes GeoNode#212

pluginadmin.py

@@ -304,9 +304,7 @@ def _get_metadata() -> typing.Dict:
             "description": poetry_conf["description"],
             "version": poetry_conf["version"],
             "tags": ", ".join(metadata.get("tags", [])),
-            "changelog": _parse_changelog(
-                _read_file("CHANGELOG.md"), poetry_conf["version"]
-            ),
+            "changelog": _parse_changelog(),
         }
     )
     return metadata
@@ -318,16 +316,29 @@ def _parse_pyproject():
         return toml.load(fh)
 
 
-def _parse_changelog(changelog: str, version: str) -> str:
-    usable_fragment = changelog.partition(f"[{version}]")[-1].partition("[unreleased]")[
-        0
-    ]
-    if usable_fragment != "":
-        no_square_brackets = re.sub(r"(\[(\d+.\d+.\d+)\])", "\g<2>", usable_fragment)
-        result = f"{version} {no_square_brackets}".replace("# ", "").replace("#", "")
-    else:
-        result = ""
-    return result
+def _parse_changelog() -> str:
+    contents = _read_file("CHANGELOG.md")
+    usable_fragment = contents.rpartition(f"## [Unreleased]")[-1].partition(
+        "[unreleased]"
+    )[0]
+    release_parts = usable_fragment.split("\n## ")
+    result = []
+    current_change_type = "unreleased"
+    for release_fragment in release_parts:
+        lines: typing.List[str] = [li for li in release_fragment.splitlines()]
+        for line in lines:
+            if line.startswith("["):
+                release, release_date = line.partition(" - ")[::2]
+                release = release.strip("[]")
+                result.append(f"\n{release} ({release_date})")
+            elif line.startswith("### "):
+                current_change_type = line.strip("### ").strip().lower()
+            elif line.startswith("-"):
+                message = line.strip("- ")
+                result.append(f"- ({current_change_type}) {message}")
+            else:
+                pass
+    return "\n".join(result)
 
 
 def _read_file(relative_path: str):

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "qgis_geonode"
 version = "1.0.0-dev"
-description = "A QGIS plugin for integrating with GeoNode"
+description = "A QGIS plugin for integrating with modern GeoNode"
 authors = ["Kartoza <[email protected]>"]
 license = "GPL-3.0-or-later"
 
@@ -37,7 +37,7 @@ exclude = """\
 [tool.qgis-plugin.metadata]
 name = "QGIS GeoNode"
 qgisMinimumVersion = "3.18"
-icon = "mIconGeonode.svg"
+icon = "plugin-logo.png"
 experimental = "True"
 deprecated = "False"
 homepage = "https://kartoza.github.io/qgis_geonode"
@@ -52,7 +52,10 @@ tags = [
 category = "plugins"
 hasProcessingProvider = "no"
 about = """\
-This plugin adds GeoNode client functionality to QGIS - Search, load and manage GeoNode resources from inside QGIS\
+This plugin adds GeoNode client functionality to QGIS - Search, load and manage GeoNode resources from inside QGIS.\
+
+It is actively maintained and aims to keep up to date with changes in the GeoNode API. Check the plugin website for \
+more detail.\
 """
 # changelog: dynamically pulled from the README.md file
 # description: dynamically pulled from the tool.poetry.description section

resources/resources.qrc

@@ -11,5 +11,8 @@
     <qresource prefix="/plugins/qgis_geonode" >
         <file>icon_wms.svg</file>
     </qresource>
+    <qresource prefix="/plugins/qgis_geonode" >
+        <file>plugin-logo.png</file>
+    </qresource>
 
 </RCC>