orionis 0.1.0__py3-none-any.whl

orionis/luminate/contracts/cache/cache_commands_interface.py

@@ -0,0 +1,69 @@
+from abc import ABC, abstractmethod
+
+class ICacheCommands(ABC):
+    """
+    Interface for managing a cache of commands.
+
+    This interface ensures that any class implementing it will provide methods
+    for registering, unregistering, and retrieving commands.
+    """
+
+    @abstractmethod
+    def register(self, signature: str, description: str, instance):
+        """
+        Register a new command with its signature, description, and class instance.
+
+        Parameters
+        ----------
+        signature : str
+            The unique identifier (signature) for the command.
+        description : str
+            A brief description of what the command does.
+        instance : class
+            The class or callable instance that defines the command behavior.
+
+        Raises
+        ------
+        ValueError
+            If a command with the given signature already exists.
+        """
+        pass
+
+    @abstractmethod
+    def unregister(self, signature: str):
+        """
+        Unregister an existing command by its signature.
+
+        Parameters
+        ----------
+        signature : str
+            The unique identifier (signature) for the command to unregister.
+
+        Raises
+        ------
+        KeyError
+            If the command with the given signature does not exist.
+        """
+        pass
+
+    @abstractmethod
+    def get(self, signature: str):
+        """
+        Retrieve the information of a registered command by its signature.
+
+        Parameters
+        ----------
+        signature : str
+            The unique identifier (signature) for the command.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the class, signature, and description of the command.
+
+        Raises
+        ------
+        KeyError
+            If the command with the given signature does not exist.
+        """
+        pass

orionis/luminate/contracts/config/config_interface.py

@@ -0,0 +1,27 @@
+from abc import ABC
+from dataclasses import dataclass
+
+@dataclass
+class EmptyData:
+    """
+    A placeholder dataclass that can be used as a default or empty configuration.
+    This class doesn't have any fields or data, but serves as a default value
+    for the 'config' attribute in classes implementing IConfig.
+    """
+    pass
+
+class IConfig(ABC):
+    """
+    An abstract base class that defines an interface for classes that must have
+    a `config` attribute.
+
+    The subclass is required to implement the `config` attribute, which should be
+    a dataclass instance representing the configuration data.
+
+    Attributes
+    ----------
+    config : object
+        A dataclass instance representing the configuration.
+    """
+
+    config = EmptyData()

orionis/luminate/contracts/config/environment_interface.py

@@ -0,0 +1,64 @@
+from abc import ABC, abstractmethod
+from typing import Optional, Dict
+
+class IEnvironment(ABC):
+    """
+    Interface for managing environment variables from a .env file.
+    """
+
+    @abstractmethod
+    def get(self, key: str, default: Optional[str] = None) -> Optional[str]:
+        """
+        Retrieve the value of an environment variable.
+
+        Parameters
+        ----------
+        key : str
+            The key of the environment variable.
+        default : Optional[str], optional
+            Default value if the key does not exist, by default None.
+
+        Returns
+        -------
+        Optional[str]
+            The value of the environment variable or the default value.
+        """
+        pass
+
+    @abstractmethod
+    def set(self, key: str, value: str) -> None:
+        """
+        Set the value of an environment variable in the .env file.
+
+        Parameters
+        ----------
+        key : str
+            The key of the environment variable.
+        value : str
+            The value to set.
+        """
+        pass
+
+    @abstractmethod
+    def unset(self, key: str) -> None:
+        """
+        Remove an environment variable from the .env file.
+
+        Parameters
+        ----------
+        key : str
+            The key of the environment variable to remove.
+        """
+        pass
+
+    @abstractmethod
+    def all(self) -> Dict[str, str]:
+        """
+        Retrieve all environment variable values from the .env file.
+
+        Returns
+        -------
+        Dict[str, str]
+            A dictionary of all environment variables and their values.
+        """
+        pass

orionis/luminate/contracts/console/base_command_interface.py

@@ -0,0 +1,448 @@
+from abc import ABC, abstractmethod
+from typing import List
+
+from orionis.luminate.console.output.progress_bar import ProgressBar
+
+class IBaseCommand(ABC):
+    """
+    Interface for console output commands. This defines the methods that must be implemented in a command class.
+    """
+
+    @abstractmethod
+    def success(self, message: str = '', timestamp: bool = True) -> None:
+        """
+        Prints a success message with a green background.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textSuccess(self, message: str = '') -> None:
+        """
+        Prints a success message in green.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def textSuccessBold(self, message: str = '') -> None:
+        """
+        Prints a bold success message in green.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def info(self, message: str = '', timestamp: bool = True) -> None:
+        """
+        Prints an informational message with a blue background.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textInfo(self, message: str = '') -> None:
+        """
+        Prints an informational message in blue.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def textInfoBold(self, message: str = '') -> None:
+        """
+        Prints a bold informational message in blue.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def warning(self, message: str = '', timestamp: bool = True) -> None:
+        """
+        Prints a warning message with a yellow background.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textWarning(self, message: str = '') -> None:
+        """
+        Prints a warning message in yellow.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def textWarningBold(self, message: str = '') -> None:
+        """
+        Prints a bold warning message in yellow.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def fail(self, message: str = '', timestamp: bool = True) -> None:
+        """
+        Prints a failure message with a red background.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def error(self, message: str = '', timestamp: bool = True) -> None:
+        """
+        Prints an error message with a red background.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textError(self, message: str = '') -> None:
+        """
+        Prints an error message in red.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def textErrorBold(self, message: str = '') -> None:
+        """
+        Prints a bold error message in red.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def textMuted(self, message: str = '') -> None:
+        """
+        Prints a muted (gray) message.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def textMutedBold(self, message: str = '') -> None:
+        """
+        Prints a bold muted (gray) message.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def textUnderline(self, message: str = '') -> None:
+        """
+        Prints an underlined message.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def clear(self) -> None:
+        """
+        Clears the console screen.
+        """
+        pass
+
+    @abstractmethod
+    def clearLine(self) -> None:
+        """
+        Clears the current console line.
+        """
+        pass
+
+    @abstractmethod
+    def line(self, message: str = '') -> None:
+        """
+        Prints a line of text.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def newLine(self, count: int = 1) -> None:
+        """
+        Prints multiple new lines.
+
+        Parameters
+        ----------
+        count : int, optional
+            The number of new lines to print (default is 1).
+        """
+        pass
+
+    @abstractmethod
+    def write(self, message: str = '') -> None:
+        """
+        Prints a message without moving to the next line.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def writeLine(self, message: str = '') -> None:
+        """
+        Prints a message and moves to the next line.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display (default is an empty string).
+        """
+        pass
+
+    @abstractmethod
+    def ask(self, question: str) -> str:
+        """
+        Prompts the user for input and returns the response.
+
+        Parameters
+        ----------
+        question : str
+            The question to ask the user.
+
+        Returns
+        -------
+        str
+            The user's input.
+        """
+        pass
+
+    @abstractmethod
+    def confirm(self, question: str, default: bool = False) -> bool:
+        """
+        Asks a confirmation question and returns True/False based on the user's response.
+
+        Parameters
+        ----------
+        question : str
+            The confirmation question to ask.
+        default : bool, optional
+            The default response if the user presses Enter without typing a response (default is False).
+
+        Returns
+        -------
+        bool
+            The user's response.
+        """
+        pass
+
+    @abstractmethod
+    def secret(self, question: str) -> str:
+        """
+        Prompts for hidden input (e.g., password).
+
+        Parameters
+        ----------
+        question : str
+            The prompt to ask the user.
+
+        Returns
+        -------
+        str
+            The user's hidden input.
+        """
+        pass
+
+    @abstractmethod
+    def table(self, headers: List[str], rows: List[List[str]]) -> None:
+        """
+        Prints a formatted table in the console.
+
+        Parameters
+        ----------
+        headers : list of str
+            The column headers for the table.
+        rows : list of list of str
+            The rows of the table.
+
+        Raises
+        ------
+        ValueError
+            If headers or rows are empty.
+        """
+        pass
+
+    @abstractmethod
+    def anticipate(self, question: str, options: List[str], default=None) -> str:
+        """
+        Provides autocomplete suggestions for user input.
+
+        Parameters
+        ----------
+        question : str
+            The prompt for the user.
+        options : list of str
+            The list of possible options for autocomplete.
+        default : str, optional
+            The default value if no matching option is found (default is None).
+
+        Returns
+        -------
+        str
+            The chosen option or the default value.
+        """
+        pass
+
+    @abstractmethod
+    def choice(self, question: str, choices: List[str], default_index: int = 0) -> str:
+        """
+        Prompts the user to select a choice from a list.
+
+        Parameters
+        ----------
+        question : str
+            The prompt for the user.
+        choices : list of str
+            The list of available choices.
+        default_index : int, optional
+            The index of the default choice (default is 0).
+
+        Returns
+        -------
+        str
+            The selected choice.
+
+        Raises
+        ------
+        ValueError
+            If `default_index` is out of the range of choices.
+        """
+        pass
+
+    @abstractmethod
+    def createProgressBar(self, total: int = 100, width: int = 50) -> ProgressBar:
+        """
+        Creates and returns a new progress bar.
+
+        This method initializes a `ProgressBar` object with the specified total and width.
+
+        Parameters
+        ----------
+        total : int, optional
+            The total number of steps for the progress bar. Default is 100.
+        width : int, optional
+            The width (in characters) of the progress bar. Default is 50.
+
+        Returns
+        -------
+        ProgressBar
+            A new instance of the `ProgressBar` class, initialized with the specified `total` and `width`.
+
+        Notes
+        -----
+        The progress bar can be used to visually track the progress of a task.
+        The `total` parameter represents the number of steps to complete the task,
+        and the `width` parameter controls the number of characters used to represent the progress bar in the console.
+        """
+        pass
+
+    @abstractmethod
+    def setArgs(self, args) -> None:
+        """
+        Abstract method to define the logic of setting command arguments.
+
+        Parameters
+        ----------
+        args : argparse.Namespace
+            Contain the arguments to be set for the command.
+        """
+        pass
+
+    @abstractmethod
+    def handle(self, *args, **kwargs):
+        """
+        Abstract method to define the logic of the command.
+
+        This method must be overridden in subclasses.
+
+        Arguments:
+            *args: A list of variable-length arguments.
+            **kwargs: Arbitrary keyword arguments.
+
+        Raises:
+            NotImplementedError: If the method is not implemented in a subclass. This ensures that all command classes
+                                adhere to the expected structure.
+        """
+        pass

orionis/luminate/contracts/console/cli_cache_interface.py

@@ -0,0 +1,34 @@
+from abc import ABC, abstractmethod
+from orionis.luminate.cache.console.commands import CacheCommands
+
+class ICLICache(ABC):
+    """
+    Interface for CLICache, defining the required methods for managing command caching.
+
+    This interface enforces a contract for any class that implements caching functionality
+    for command execution within the framework.
+    """
+
+    @abstractmethod
+    def _load_commands(self) -> None:
+        """
+        Loads command modules from predefined directories.
+
+        This method should traverse specified directories, locate Python files, and import them dynamically.
+        Implementations should ensure that only relevant directories are processed.
+        """
+        pass
+
+    @abstractmethod
+    def getCommands(self) -> CacheCommands:
+        """
+        Returns the instance of CacheCommands containing the command cache.
+
+        This method provides access to the CacheCommands instance, which holds the cached commands.
+
+        Returns
+        -------
+        CacheCommands
+            The instance of CacheCommands that holds the cached commands.
+        """
+        pass

orionis/luminate/contracts/console/command_filter_interface.py

@@ -0,0 +1,32 @@
+from abc import ABC, abstractmethod
+
+class ICommandFilter(ABC):
+    """
+    CommandFilter handles the exclusion of specific commands from output formatting.
+
+    This class:
+    - Determines whether a command should be excluded from output formatting based on a predefined list.
+    - Can be extended or modified to support more advanced filtering if needed.
+
+    Methods
+    -------
+    isExcluded(command: str) -> bool
+        Checks if the given command is excluded from output formatting.
+    """
+
+    @abstractmethod
+    def isExcluded(command: str) -> bool:
+        """
+        Checks if the given command is in the excluded commands list.
+
+        Parameters
+        ----------
+        command : str
+            The command to check.
+
+        Returns
+        -------
+        bool
+            Returns True if the command is excluded from output formatting, False otherwise.
+        """
+        pass