Make curation fail; add docstrings

Author: zyzzyxdonta

.github/workflows/hermes-run.yml

@@ -20,8 +20,12 @@ jobs:
       - name: Print Python version
         run: python -c "import sys; print(sys.version)"
       - name: Install package
-        run: pip install -e .
-      - run: hermes clean || (cat hermes.log && false)
-      - run: hermes harvest || (cat hermes.log && false)
-      - run: hermes process || (cat hermes.log && false)
-      - run: hermes curate || (cat hermes.log && false)
+        run: python -m pip install -e .
+      - name: hermes clean
+        run: hermes clean || (cat hermes.log && false)
+      - name: hermes harvest
+        run: hermes harvest || (cat hermes.log && false)
+      - name: hermes process
+        run: hermes process || (cat hermes.log && false)
+      - name: hermes curate
+        run: hermes curate || (cat hermes.log && false)

hermes.toml

@@ -4,4 +4,4 @@
 # SPDX-License-Identifier: CC0-1.0
 
 [curate]
-method = "software-card"
+method = "software_card"

pyproject.toml

@@ -37,7 +37,7 @@ homepage = "https://github.com/softwarepub/hermes-plugin-software-card"
 repository = "https://github.com/softwarepub/hermes-plugin-software-card.git"
 
 [project.entry-points."hermes.curate"]
-software-card = "hermes_plugin_software_card.curate:SoftwareCaRDCuratePlugin"
+software_card = "hermes_plugin_software_card.curate:SoftwareCaRDCuratePlugin"
 
 [tool.ruff.lint]
 select = [
@@ -48,6 +48,7 @@ select = [
     "C4",
     "C90",
     "COM",
+    "D",
     "DTZ",
     "E",
     "EM",
@@ -78,4 +79,7 @@ select = [
 ]
 ignore = ["COM812"]
 
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
 [tool.setuptools_scm]

src/hermes_plugin_software_card/__init__.py

@@ -2,3 +2,5 @@
 # SPDX-FileContributor: David Pape
 #
 # SPDX-License-Identifier: Apache-2.0
+
+"""HERMES plugins for the Software CaRD framework."""

src/hermes_plugin_software_card/curate.py

@@ -3,8 +3,14 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+"""Module containing the Software CaRD curation plugin for HERMES."""
+
 from hermes.commands.curate.base import BaseCuratePlugin
 
 
 class SoftwareCaRDCuratePlugin(BaseCuratePlugin):
-    pass
+    """Software CaRD curation plugin."""
+
+    def is_publication_approved(self):
+        """Decide whether the publication of the software is approved."""
+        return False