Plugin selection

Author: nheeb

src/hermes/commands/init/base.py

@@ -19,6 +19,7 @@
 from requests import HTTPError
 
 import hermes.commands.init.util.slim_click as sc
+from hermes.commands import marketplace
 from hermes.commands.base import HermesCommand, HermesPlugin
 from hermes.commands.init.util import (connect_github, connect_gitlab,
                                        connect_zenodo, git_info)
@@ -58,15 +59,10 @@ class HermesInitFolderInfo:
     def __init__(self):
         self.absolute_path: str = ""
         self.has_git_folder: bool = False
-        # self.has_multiple_remotes: bool = False
-        # self.git_remote_url: str = ""
-        # self.git_base_url: str = ""
-        # self.used_git_hoster: GitHoster = GitHoster.Empty
         self.has_hermes_toml: bool = False
         self.has_gitignore: bool = False
         self.has_citation_cff: bool = False
         self.has_readme: bool = False
-        # self.current_branch: str = ""
         self.current_dir: str = ""
         self.dir_list: list[str] = []
         self.dir_folders: list[str] = []
@@ -180,6 +176,7 @@ def __init__(self, parser: argparse.ArgumentParser):
         }
         self.plugin_relevant_commands = ["harvest", "deposit"]
         self.builtin_plugins: dict[str: HermesPlugin] = get_builtin_plugins(self.plugin_relevant_commands)
+        self.selected_plugins: list[marketplace.PluginInfo] = []
 
     def init_command_parser(self, command_parser: argparse.ArgumentParser) -> None:
         command_parser.add_argument('--template-branch', nargs=1, default="",
@@ -217,7 +214,10 @@ def __call__(self, args: argparse.Namespace) -> None:
         self.test_initialization()
 
         sc.echo(f"Starting to initialize HERMES in {self.folder_info.absolute_path}")
-        sc.max_steps = 7
+        sc.max_steps = 8
+
+        sc.next_step("Configure HERMES plugins")
+        self.choose_plugins()
 
         sc.next_step("Configure deposition platform and setup method")
         self.choose_deposit_platform()
@@ -595,6 +595,38 @@ def connect_deposit_platform(self) -> None:
                 connect_zenodo.setup(using_sandbox=True)
                 self.create_zenodo_token()
 
+    def choose_plugins(self):
+        """User chooses the plugins he wants to use."""
+        plugin_infos: list[marketplace.PluginInfo] = marketplace.get_plugin_infos()
+        plugins_builtin: list[marketplace.PluginInfo] = list(filter(lambda p: p.builtin, plugin_infos))
+        plugins_available: list[marketplace.PluginInfo] = list(filter(lambda p: not p.builtin, plugin_infos))
+        plugins_selected: list[marketplace.PluginInfo] = []
+        sc.echo("The following plugins are already builtin:")
+        for info in plugins_builtin:
+            sc.echo(str(info), formatting=sc.Formats.OKGREEN)
+        sc.echo("")
+        while True:
+            if plugins_selected:
+                sc.echo("The following plugins are going to be installed:")
+                for info in plugins_selected:
+                    sc.echo(str(info), formatting=sc.Formats.OKCYAN)
+                sc.echo("")
+            if plugins_available:
+                sc.echo("The following plugins are available for installation:")
+                for info in plugins_available:
+                    sc.echo(str(info), formatting=sc.Formats.WARNING, no_log=True)
+                sc.echo("")
+            else:
+                self.selected_plugins = plugins_selected
+                break
+            choice = sc.choose("Do you want to add a plugin?", ["No"] + [p.name for p in plugins_available])
+            if choice == 0:
+                self.selected_plugins = plugins_selected
+                break
+            else:
+                chosen_plugin = plugins_available.pop(choice - 1)
+                plugins_selected.append(chosen_plugin)
+
     def no_git_setup(self, start_question: str = "") -> None:
         """Makes the init for a gitless project (basically just creating hermes.toml)"""
         if start_question == "":

src/hermes/commands/init/util/slim_click.py

@@ -62,18 +62,19 @@ def get_log_type(self, default: int = logging.INFO) -> int:
         return default
 
 
-def echo(text: str, formatting: Formats = Formats.EMPTY, log_as: int = logging.NOTSET):
+def echo(text: str, formatting: Formats = Formats.EMPTY, log_as: int = logging.NOTSET, no_log: bool = False):
     """
     Prints the text with the given formatting. If log_as is set or AUTO_LOG_ON_ECHO is true it gets logged as well.
     :param text: The printed text.
     :param formatting: You can use the Formats Enum to give the text a special color or formatting.
     :param log_as: Creates a log entry with the given text if this is set.
+    :param no_log: Never creates a log entry if True.
     """
     # Get logging type from formatting if AUTO_LOG_ON_ECHO
     if AUTO_LOG_ON_ECHO and log_as == logging.NOTSET and text != "":
         log_as = formatting.get_log_type(logging.INFO)
     # Add text to log if there is a logger
-    if log_as != logging.NOTSET and default_file_logger:
+    if log_as != logging.NOTSET and default_file_logger and no_log == False:
         default_file_logger.log(log_as, text)
     # Format the text for the console
     if formatting != Formats.EMPTY:

src/hermes/commands/marketplace.py

@@ -96,6 +96,38 @@ def _sort_plugins_by_step(plugins: list[SchemaOrgSoftwareApplication]) -> dict[s
     return sorted_plugins
 
 
+def _plugin_loc(_plugin: SchemaOrgSoftwareApplication) -> str:
+    return "builtin" if _plugin.is_part_of == schema_org_hermes else (_plugin.url or "")
+
+class PluginInfo:
+    def __init__(self):
+        self.name: str = ""
+        self.location: str = ""
+        self.step: str = ""
+        self.builtin: bool = True
+    def __str__(self):
+        return f"[{self.step}] {self.name} ({self.location})"
+
+
+def get_plugin_infos() -> list[PluginInfo]:
+    response = requests.get(MARKETPLACE_URL, headers={"User-Agent": hermes_user_agent})
+    response.raise_for_status()
+    parser = PluginMarketPlaceParser()
+    parser.feed(response.text)
+    infos: list[PluginInfo] = []
+    if parser.plugins:
+        plugins_sorted = _sort_plugins_by_step(parser.plugins)
+        for step in plugins_sorted.keys():
+            for plugin in plugins_sorted[step]:
+                info = PluginInfo()
+                info.name = plugin.name
+                info.step = step
+                info.location = _plugin_loc(plugin)
+                info.builtin = plugin.is_part_of == schema_org_hermes
+                infos.append(info)
+    return infos
+
+
 def main():
     response = requests.get(MARKETPLACE_URL, headers={"User-Agent": hermes_user_agent})
     response.raise_for_status()
@@ -108,9 +140,6 @@ def main():
         MARKETPLACE_URL + "."
     )
 
-    def _plugin_loc(_plugin: SchemaOrgSoftwareApplication) -> str:
-        return "builtin" if _plugin.is_part_of == schema_org_hermes else (_plugin.url or "")
-
     if parser.plugins:
         print()
         max_name_len = max(map(lambda plugin: len(plugin.name), parser.plugins))