orionis 0.1.0__py3-none-any.whl

orionis/luminate/contracts/files/paths_interface.py

@@ -0,0 +1,29 @@
+from abc import ABC, abstractmethod
+
+class ISkeletonPath(ABC):
+    """
+    Resolves the absolute path for a given relative directory based on the script's execution directory.
+    Ensures that the requested path is a valid directory.
+
+    Attributes
+    ----------
+    route : str
+        The resolved absolute path to the directory.
+
+    Methods
+    -------
+    __str__():
+        Returns the absolute path as a string.
+    """
+
+    @abstractmethod
+    def resolve(self) -> str:
+        """
+        Returns the absolute path as a string.
+
+        Returns
+        -------
+        str
+            The absolute directory path.
+        """
+        pass

orionis/luminate/contracts/installer/output_interface.py

@@ -0,0 +1,125 @@
+from abc import ABC, abstractmethod
+
+class IOutput(ABC):
+    """
+    Interface defining the contract for the Output class.
+
+    This interface ensures that any implementing class provides methods for
+    displaying messages, ASCII-based framework information, and handling errors.
+
+    Methods
+    -------
+    asciiIco() -> None
+        Displays the framework's ASCII icon along with relevant information.
+    asciiInfo() -> None
+        Displays additional ASCII-based information about the framework.
+    startInstallation() -> None
+        Shows a welcome message when installation starts.
+    endInstallation() -> None
+        Shows a completion message when installation finishes.
+    info(message: str) -> None
+        Displays an informational message.
+    fail(message: str) -> None
+        Displays a failure message.
+    error(message: str) -> None
+        Displays an error message and terminates the program.
+    """
+
+    @abstractmethod
+    def asciiIco(self) -> None:
+        """
+        Displays the framework's ASCII icon along with relevant information.
+
+        Raises
+        ------
+        Exception
+            If an error occurs while displaying the ASCII art.
+        """
+        pass
+
+    @abstractmethod
+    def asciiInfo(self) -> None:
+        """
+        Displays additional ASCII-based information about the framework.
+
+        Raises
+        ------
+        Exception
+            If an error occurs while displaying the ASCII information.
+        """
+        pass
+
+    @abstractmethod
+    def startInstallation(self) -> None:
+        """
+        Shows a welcome message when installation starts.
+
+        Raises
+        ------
+        Exception
+            If an error occurs during message display.
+        """
+        pass
+
+    @abstractmethod
+    def endInstallation(self) -> None:
+        """
+        Shows a completion message when installation finishes.
+
+        Raises
+        ------
+        Exception
+            If an error occurs during message display.
+        """
+        pass
+
+    @abstractmethod
+    def info(self, message: str) -> None:
+        """
+        Displays an informational message.
+
+        Parameters
+        ----------
+        message : str
+            The message to display.
+
+        Raises
+        ------
+        Exception
+            If an error occurs while displaying the message.
+        """
+        pass
+
+    @abstractmethod
+    def fail(self, message: str) -> None:
+        """
+        Displays a failure message.
+
+        Parameters
+        ----------
+        message : str
+            The message to display.
+
+        Raises
+        ------
+        Exception
+            If an error occurs while displaying the message.
+        """
+        pass
+
+    @abstractmethod
+    def error(self, message: str) -> None:
+        """
+        Displays an error message and terminates the program.
+
+        Parameters
+        ----------
+        message : str
+            The message to display.
+
+        Raises
+        ------
+        SystemExit
+            Terminates the program with an exit code.
+        """
+        pass

orionis/luminate/contracts/installer/setup_interface.py

@@ -0,0 +1,29 @@
+from abc import ABC, abstractmethod
+
+class ISetup(ABC):
+    """
+    Abstract base class for setup operations.
+
+    This interface defines a contract for setup classes, requiring the implementation
+    of the `handle` method to execute setup logic.
+
+    Methods
+    -------
+    handle()
+        Abstract method that must be implemented by subclasses to define setup behavior.
+    """
+
+    @abstractmethod
+    def handle(self):
+        """
+        Execute the setup process.
+
+        This method must be implemented by any subclass to perform the necessary
+        setup actions. The specific implementation details depend on the subclass.
+
+        Raises
+        ------
+        NotImplementedError
+            If the method is not implemented in a subclass.
+        """
+        pass

orionis/luminate/contracts/installer/upgrade_interface.py

@@ -0,0 +1,24 @@
+from abc import ABC, abstractmethod
+
+class IUpgrade(ABC):
+    """
+    Interface for the Upgrade process in Orionis.
+
+    This interface enforces the implementation of methods required to handle
+    upgrading Orionis to the latest version.
+    """
+
+    @abstractmethod
+    def execute() -> None:
+        """
+        Executes the upgrade process for Orionis.
+
+        This method should be implemented to define the upgrade logic, ensuring
+        the application is updated to the latest available version.
+
+        Raises
+        ------
+        ValueError
+            If the upgrade process fails or encounters any error during execution.
+        """
+        pass

orionis/luminate/contracts/log/logger_interface.py

@@ -0,0 +1,33 @@
+from abc import ABC, abstractmethod
+
+class ILogger(ABC):
+    """
+    Abstract base class for a logger.
+
+    This defines the contract that any concrete logger class must implement.
+    """
+
+    @abstractmethod
+    def info(self, message: str) -> None:
+        """Logs an informational message."""
+        pass
+
+    @abstractmethod
+    def error(self, message: str) -> None:
+        """Logs an error message."""
+        pass
+
+    @abstractmethod
+    def success(self, message: str) -> None:
+        """Logs a success message (treated as info)."""
+        pass
+
+    @abstractmethod
+    def warning(self, message: str) -> None:
+        """Logs a warning message."""
+        pass
+
+    @abstractmethod
+    def debug(self, message: str) -> None:
+        """Logs a debug message."""
+        pass

orionis/luminate/contracts/pipelines/cli_pipeline_interface.py

@@ -0,0 +1,84 @@
+from abc import ABC, abstractmethod
+from typing import Any, Dict, Optional
+
+class ICLIPipeline(ABC):
+    """
+    Interface for CLIPipeline, defining the structure for handling CLI command retrieval,
+    argument parsing, and execution.
+
+    Methods
+    -------
+    getCommand(signature: str) -> "ICLIPipeline"
+        Retrieves a command from the cache based on its signature.
+
+    parseArguments(vars: Optional[Dict[str, Any]] = None, *args, **kwargs) -> "ICLIPipeline"
+        Parses command-line arguments using the framework's argument parser.
+
+    execute() -> Any
+        Executes the retrieved command using parsed arguments.
+    """
+
+    @abstractmethod
+    def getCommand(self, signature: str) -> "ICLIPipeline":
+        """
+        Retrieves a command from the cache based on its signature.
+
+        Parameters
+        ----------
+        signature : str
+            The unique identifier of the command.
+
+        Returns
+        -------
+        ICLIPipeline
+            The current instance of the pipeline for method chaining.
+
+        Raises
+        ------
+        ValueError
+            If the command signature is not found in the cache.
+        """
+        pass
+
+    @abstractmethod
+    def parseArguments(self, vars: Optional[Dict[str, Any]] = None, *args, **kwargs) -> "ICLIPipeline":
+        """
+        Parses command-line arguments using the framework's argument parser.
+
+        Parameters
+        ----------
+        vars : dict, optional
+            A dictionary of predefined variables to be included in parsing.
+        *args
+            Positional arguments for the parser.
+        **kwargs
+            Keyword arguments for the parser.
+
+        Returns
+        -------
+        ICLIPipeline
+            The current instance of the pipeline for method chaining.
+
+        Raises
+        ------
+        ValueError
+            If an error occurs during argument parsing.
+        """
+        pass
+
+    @abstractmethod
+    def execute(self) -> Any:
+        """
+        Executes the retrieved command using parsed arguments.
+
+        Returns
+        -------
+        Any
+            The output of the command execution.
+
+        Raises
+        ------
+        ValueError
+            If the command instance is invalid.
+        """
+        pass

orionis/luminate/contracts/publisher/pypi_publisher_interface.py

@@ -0,0 +1,36 @@
+from abc import ABC, abstractmethod
+
+class IPypiPublisher(ABC):
+    """
+    Interface for managing the publishing process of a package to PyPI
+    and handling repository operations.
+    """
+
+    @abstractmethod
+    def gitPush(self):
+        """
+        Commits and pushes changes to the Git repository if modifications are detected.
+        """
+        pass
+
+    @abstractmethod
+    def publish(self):
+        """
+        Uploads the package to PyPI using Twine.
+
+        The PyPI token should be retrieved from the environment variable or
+        passed during initialization.
+        """
+        pass
+
+    @abstractmethod
+    def clearRepository(self):
+        """
+        Deletes temporary directories created during the publishing process.
+
+        The following directories should be removed:
+        - build
+        - dist
+        - orionis.egg-info
+        """
+        pass

orionis/luminate/contracts/test/unit_test_interface.py

@@ -0,0 +1,51 @@
+from abc import ABC, abstractmethod
+
+class IUnitTest(ABC):
+    """
+    A testing framework for discovering and running unit tests in a structured way.
+
+    Attributes
+    ----------
+    loader : unittest.TestLoader
+        A test loader instance used to discover tests.
+    suite : unittest.TestSuite
+        A test suite that holds all discovered tests.
+
+    Methods
+    -------
+    add_folder_tests(folder_path: str, pattern: str = 'test_*.py') -> None
+        Adds test cases from a specified folder to the test suite.
+    run_tests() -> None
+        Executes all tests in the test suite and raises an exception if any fail.
+    """
+
+    @abstractmethod
+    def addFolderTests(self, folder_path: str, pattern: str = "test_*.py") -> None:
+        """
+        Adds all test cases from a specified folder to the test suite.
+
+        Parameters
+        ----------
+        folder_path : str
+            The relative path to the folder containing test files.
+        pattern : str, optional
+            A pattern to match test files (default is 'test_*.py').
+
+        Raises
+        ------
+        ValueError
+            If the folder path is invalid or no tests are found.
+        """
+        pass
+
+    @abstractmethod
+    def run(self) -> None:
+        """
+        Runs all tests added to the test suite.
+
+        Raises
+        ------
+        OrionisTestFailureException
+            If one or more tests fail.
+        """
+        pass