orionis 0.458.0__tar.gz → 0.460.0__tar.gz

{orionis-0.458.0/orionis.egg-info → orionis-0.460.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.458.0
+Version: 0.460.0
 Summary: Orionis Framework – Elegant, Fast, and Powerful.
 Home-page: https://github.com/orionis-framework/framework
 Author: Raul Mauricio Uñate Castro

orionis-0.460.0/orionis/console/commands/help.py

@@ -0,0 +1,83 @@
+from orionis.console.base.command import BaseCommand
+from orionis.console.contracts.reactor import IReactor
+from orionis.console.exceptions import CLIOrionisRuntimeError
+from rich.console import Console
+from rich.panel import Panel
+
+class HelpCommand(BaseCommand):
+    """
+    Command class to display usage information for the Orionis CLI.
+    """
+
+    # Indicates whether timestamps will be shown in the command output
+    timestamps: bool = False
+
+    # Command signature and description
+    signature: str = "help"
+
+    # Command description
+    description: str = "Displays usage information, examples, and a list of available commands in the Orionis CLI."
+
+    def handle(self, reactor: IReactor) -> None:
+        """
+        Displays usage information and a list of available commands for the Orionis CLI.
+
+        Parameters
+        ----------
+        reactor : IReactor
+            The reactor instance providing command metadata via the `info()` method.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It prints help information to the console.
+
+        Raises
+        ------
+        CLIOrionisRuntimeError
+            If an unexpected error occurs during help information generation or display.
+        """
+        try:
+
+            # Retrieve the list of available commands from the reactor
+            commands = reactor.info()  # List of dicts with 'signature' and 'description'
+
+            # Initialize the rich console for formatted output
+            console = Console()
+
+            # Build the usage and commands help text
+            usage = "[bold cyan]Usage:[/]\n  python -B <command> <params/flags>\n\n"
+            usage += "[bold cyan]Example:[/]\n  python -B app:command --flag\n\n"
+            usage += "[bold cyan]Available Commands:[/]\n"
+
+            # Determine the maximum signature length for alignment
+            max_sig_len = max((len(cmd['signature']) for cmd in commands), default=0)
+
+            # Append each command's signature and description to the usage string
+            for cmd in commands:
+                usage += f"  [bold yellow]{cmd['signature']:<{max_sig_len}}[/]  {cmd['description']}\n"
+
+            # Add options section
+            usage += (
+                "\n[bold cyan]Options:[/]\n"
+                "  -h, --help    Show this help message and exit"
+            )
+
+            # Create a rich panel to display the help information
+            panel = Panel(
+                usage,
+                title="[bold green]Orionis CLI Help[/]",
+                expand=False,
+                border_style="bright_blue",
+                padding=(1, 2)
+            )
+
+            # Print the panel to the console
+            console.print()
+            console.print(panel)
+            console.print()
+
+        except Exception as e:
+
+            # Raise a custom runtime error if any exception occurs
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e

{orionis-0.458.0 → orionis-0.460.0}/orionis/console/commands/test.py

@@ -24,7 +24,7 @@ class TestCommand(BaseCommand):
     signature: str = "test"
 
     # Command description
-    description: str = "Prints help information for the Orionis CLI commands."
+    description: str = "Executes all automated tests using the configured test kernel for the Orionis application."
 
     def handle(self) -> None:
         """

{orionis-0.458.0 → orionis-0.460.0}/orionis/console/commands/version.py

@@ -25,7 +25,7 @@ class VersionCommand(BaseCommand):
     signature: str = "version"
 
     # Command description
-    description: str = "Prints the version of the framework in use."
+    description: str = "Displays the current Orionis framework version and metadata, including author, Python requirements, documentation, and repository links."
 
     def handle(self) -> None:
         """

{orionis-0.458.0 → orionis-0.460.0}/orionis/console/contracts/reactor.py

@@ -36,4 +36,22 @@ class IReactor(ABC):
         SystemExit
             If argument parsing fails due to invalid arguments provided.
         """
+        pass
+
+    @abstractmethod
+    def info(self) -> List[dict]:
+        """
+        Retrieves a list of all registered commands with their metadata.
+
+        This method returns a list of dictionaries, each containing information about
+        a registered command, including its signature, description, and whether it has
+        timestamps enabled. This is useful for introspection and displaying available
+        commands to the user.
+
+        Returns
+        -------
+        List[dict]
+            A list of dictionaries representing the registered commands, where each dictionary
+            contains the command's signature, description, and timestamps status.
+        """
         pass

{orionis-0.458.0 → orionis-0.460.0}/orionis/console/core/reactor.py

@@ -397,6 +397,33 @@ class Reactor(IReactor):
         # Return the configured ArgumentParser
         return arg_parser
 
+    def info(self) -> List[dict]:
+        """
+        Retrieves a list of all registered commands with their metadata.
+
+        This method returns a list of dictionaries, each containing information about
+        a registered command, including its signature, description, and whether it has
+        timestamps enabled. This is useful for introspection and displaying available
+        commands to the user.
+
+        Returns
+        -------
+        List[dict]
+            A list of dictionaries representing the registered commands, where each dictionary
+            contains the command's signature, description, and timestamps status.
+        """
+
+        # Prepare a list to hold command information
+        commands_info = []
+        for command in self.__commands.values():
+            commands_info.append({
+                "signature": command.get("signature"),
+                "description": command.get("description"),
+            })
+
+        # Return the sorted list of command information by signature
+        return sorted(commands_info, key=lambda x: x["signature"].lower())
+
     def call(
         self,
         signature: str,

{orionis-0.458.0 → orionis-0.460.0}/orionis/metadata/framework.py

@@ -5,7 +5,7 @@
 NAME = "orionis"
 
 # Current version of the framework
-VERSION = "0.458.0"
+VERSION = "0.460.0"
 
 # Full name of the author or maintainer of the project
 AUTHOR = "Raul Mauricio Uñate Castro"

{orionis-0.458.0 → orionis-0.460.0/orionis.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.458.0
+Version: 0.460.0
 Summary: Orionis Framework – Elegant, Fast, and Powerful.
 Home-page: https://github.com/orionis-framework/framework
 Author: Raul Mauricio Uñate Castro

orionis-0.458.0/orionis/console/commands/help.py

@@ -1,36 +0,0 @@
-from orionis.console.base.command import BaseCommand
-from orionis.console.exceptions import CLIOrionisRuntimeError
-from rich.console import Console
-from rich.panel import Panel
-
-class HelpCommand(BaseCommand):
-    """
-    Command class to display usage information for the Orionis CLI.
-    """
-
-    timestamps: bool = False
-    signature: str = "help"
-    description: str = "Prints help information for the Orionis CLI commands."
-
-    def handle(self) -> None:
-        """
-        Executes the command to display usage information for the Orionis CLI.
-        """
-        try:
-            console = Console()
-            usage = (
-                "[bold cyan]Usage:[/]\n"
-                "  orionis <command> [options]\n\n"
-                "[bold cyan]Available Commands:[/]\n"
-                "  help        Show this help message\n"
-                "  run         Run the application\n"
-                "  make        Generate code scaffolding\n"
-                "  migrate     Run database migrations\n"
-                "  ...         Other available commands\n\n"
-                "[bold cyan]Options:[/]\n"
-                "  -h, --help  Show this help message and exit\n"
-            )
-            panel = Panel(usage, title="[bold green]Orionis CLI Help[/]", expand=False, border_style="bright_blue")
-            console.print(panel)
-        except Exception as e:
-            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e