orionis 0.459.0__py3-none-any.whl → 0.460.0__py3-none-any.whl

orionis/console/commands/help.py

@@ -1,4 +1,5 @@
 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
@@ -8,29 +9,75 @@ 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"
-    description: str = "Prints help information for the Orionis CLI commands."
 
-    def handle(self) -> None:
+    # Command description
+    description: str = "Displays usage information, examples, and a list of available commands in the Orionis CLI."
+
+    def handle(self, reactor: IReactor) -> None:
         """
-        Executes the command to display usage information for the Orionis CLI.
+        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()
-            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"
+
+            # 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)
             )
-            panel = Panel(usage, title="[bold green]Orionis CLI Help[/]", expand=False, border_style="bright_blue")
+
+            # 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/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/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/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/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/metadata/framework.py

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

{orionis-0.459.0.dist-info → orionis-0.460.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.459.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.459.0.dist-info → orionis-0.460.0.dist-info}/RECORD

@@ -11,14 +11,14 @@ orionis/console/base/command.py,sha256=nasVPyKEvuv8sDFEWXhHyBCWAmSLfPPm2XlKaYYt_
 orionis/console/base/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/base/contracts/command.py,sha256=vmAJD0yMQ5-AD_s9_xCFEAl64sKk65z7U2E196dALQM,5760
 orionis/console/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/console/commands/help.py,sha256=EGg5FfWnLasi7I7gCTBLyvau6I0gVpc2ewNefyJlHeE,1494
-orionis/console/commands/test.py,sha256=TgiK-6s23ZEiSdUekdngmpcmoqZYGcy8F7YoX-afk3Y,2151
-orionis/console/commands/version.py,sha256=NhLzMrr022mIY4C4SjX_FfKNDXWfIPyWAqzpx_9Hi2k,3547
+orionis/console/commands/help.py,sha256=q8UlSm1kKspl391oRWmt0DZFJHE1mp358Fv8wyWFcsE,3072
+orionis/console/commands/test.py,sha256=yw5Cvi5YQdnUM3o33HYnphT_rKLIvP3W8ow1xhUY1-4,2188
+orionis/console/commands/version.py,sha256=RhON-KZt8bJfMcFTk3MB9aQgRnG7ZghD4f5gX9z81Ps,3640
 orionis/console/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/contracts/kernel.py,sha256=mh4LlhEYHh3FuGZZQ0GBhD6ZLa5YQvaNj2r01IIHI5Y,826
-orionis/console/contracts/reactor.py,sha256=fT49-794RI-y0ZhDyXf91VQoFdGx6kF1Kg-monJnj7s,1296
+orionis/console/contracts/reactor.py,sha256=GGhWSNYBE6E_W3HNEi4kjiDwqohsa-nnwJfoC1nJPM8,1998
 orionis/console/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/console/core/reactor.py,sha256=0d-2Gp3PGoLQeDZwZemKnRjQaAs0O8O3cb2GZnm8OkA,21708
+orionis/console/core/reactor.py,sha256=XTgQZyi9Z2epYPOlFc05wXaX_69-fL8GEobIN2UkZsE,22825
 orionis/console/dumper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/dumper/dump.py,sha256=CATERiQ6XuIrKQsDaWcVxzTtlAJI9qLJX44fQxEX8ws,22443
 orionis/console/dumper/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -184,7 +184,7 @@ orionis/foundation/providers/reactor_provider.py,sha256=P0KQcp4AFKTrD6BStGfCTqhG
 orionis/foundation/providers/testing_provider.py,sha256=SrJRpdvcblx9WvX7x9Y3zc7OQfiTf7la0HAJrm2ESlE,3725
 orionis/foundation/providers/workers_provider.py,sha256=oa_2NIDH6UxZrtuGkkoo_zEoNIMGgJ46vg5CCgAm7wI,3926
 orionis/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/metadata/framework.py,sha256=OVAWdZLzd6BJfIxZft1kImeNLy1pIeap9mw2Vmxispw,4088
+orionis/metadata/framework.py,sha256=0PF-xadVQmg1GOQI54wxR7uPM9jc_FB2x0bKKHxOR-w,4088
 orionis/metadata/package.py,sha256=k7Yriyp5aUcR-iR8SK2ec_lf0_Cyc-C7JczgXa-I67w,16039
 orionis/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/services/asynchrony/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -349,7 +349,7 @@ orionis/test/validators/web_report.py,sha256=n9BfzOZz6aEiNTypXcwuWbFRG0OdHNSmCNu
 orionis/test/validators/workers.py,sha256=rWcdRexINNEmGaO7mnc1MKUxkHKxrTsVuHgbnIfJYgc,1206
 orionis/test/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/test/view/render.py,sha256=f-zNhtKSg9R5Njqujbg2l2amAs2-mRVESneLIkWOZjU,4082
-orionis-0.459.0.dist-info/licenses/LICENCE,sha256=JhC-z_9mbpUrCfPjcl3DhDA8trNDMzb57cvRSam1avc,1463
+orionis-0.460.0.dist-info/licenses/LICENCE,sha256=JhC-z_9mbpUrCfPjcl3DhDA8trNDMzb57cvRSam1avc,1463
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/container/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/container/context/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -492,8 +492,8 @@ tests/testing/validators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 tests/testing/validators/test_testing_validators.py,sha256=WPo5GxTP6xE-Dw3X1vZoqOMpb6HhokjNSbgDsDRDvy4,16588
 tests/testing/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/testing/view/test_render.py,sha256=tnnMBwS0iKUIbogLvu-7Rii50G6Koddp3XT4wgdFEYM,1050
-orionis-0.459.0.dist-info/METADATA,sha256=DvbDAHKJQSOxDRplgWjNmGwb1Tlt6OoaptuVR1jDP88,4772
-orionis-0.459.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-orionis-0.459.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.459.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-orionis-0.459.0.dist-info/RECORD,,
+orionis-0.460.0.dist-info/METADATA,sha256=kMihwp0zpZKD5J9NVo-O4_TBkIozgsQ9R4ksn9-5WnE,4772
+orionis-0.460.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+orionis-0.460.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
+orionis-0.460.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+orionis-0.460.0.dist-info/RECORD,,