orionis 0.1.0__py3-none-any.whl

orionis/luminate/config/dataclass/database.py

@@ -0,0 +1,203 @@
+from typing import Optional
+from dataclasses import dataclass
+
+@dataclass
+class Sqlite:
+    """
+    Data class to represent the SQLite database configuration.
+
+    Attributes
+    ----------
+    driver : str
+        The database driver being used, e.g., 'sqlite'.
+    url : str
+        The URL for connecting to the database.
+    database : str
+        The path to the SQLite database file.
+    prefix : str
+        Prefix for table names.
+    foreign_key_constraints : bool
+        Whether foreign key constraints are enabled.
+    busy_timeout : Optional[int]
+        The timeout period (in milliseconds) before retrying a locked database.
+    journal_mode : Optional[str]
+        The journal mode used for transactions.
+    synchronous : Optional[str]
+        The synchronization level for the database.
+    """
+    driver: str
+    url: str
+    database: str
+    prefix: str
+    foreign_key_constraints: bool
+    busy_timeout: Optional[int]
+    journal_mode: Optional[str]
+    synchronous: Optional[str]
+
+@dataclass
+class Mysql:
+    """
+    Data class to represent the MySQL database configuration.
+
+    Attributes
+    ----------
+    driver : str
+        The database driver being used, e.g., 'mysql'.
+    url : str
+        The URL for connecting to the database.
+    host : str
+        The host address for the MySQL server.
+    port : str
+        The port for connecting to the MySQL server.
+    database : str
+        The name of the MySQL database.
+    username : str
+        The username for connecting to the MySQL database.
+    password : str
+        The password for the MySQL database.
+    unix_socket : str
+        The path to the Unix socket for MySQL connections (optional).
+    charset : str
+        The charset used for the connection.
+    collation : str
+        The collation for the database.
+    prefix : str
+        Prefix for table names.
+    prefix_indexes : bool
+        Whether to prefix index names.
+    strict : bool
+        Whether to enforce strict SQL mode.
+    engine : Optional[str]
+        The storage engine for the MySQL database (optional).
+    """
+    driver: str
+    url: str
+    host: str
+    port: str
+    database: str
+    username: str
+    password: str
+    unix_socket: str
+    charset: str
+    collation: str
+    prefix: str
+    prefix_indexes: bool
+    strict: bool
+    engine: Optional[str]
+
+@dataclass
+class Pgsql:
+    """
+    Data class to represent the PostgreSQL database configuration.
+
+    Attributes
+    ----------
+    driver : str
+        The database driver being used, e.g., 'pgsql'.
+    url : str
+        The URL for connecting to the database.
+    host : str
+        The host address for the PostgreSQL server.
+    port : str
+        The port for connecting to the PostgreSQL server.
+    database : str
+        The name of the PostgreSQL database.
+    username : str
+        The username for connecting to the PostgreSQL database.
+    password : str
+        The password for the PostgreSQL database.
+    charset : str
+        The charset used for the connection.
+    prefix : str
+        Prefix for table names.
+    prefix_indexes : bool
+        Whether to prefix index names.
+    search_path : str
+        The schema search path for PostgreSQL.
+    sslmode : str
+        The SSL mode for the connection.
+    """
+    driver: str
+    url: str
+    host: str
+    port: str
+    database: str
+    username: str
+    password: str
+    charset: str
+    prefix: str
+    prefix_indexes: bool
+    search_path: str
+    sslmode: str
+
+@dataclass
+class Oracle:
+    """
+    Data class to represent the Oracle database configuration.
+
+    Attributes
+    ----------
+    driver : str
+        The database driver being used, e.g., 'oracle'.
+    dsn : str
+        The Data Source Name (DSN) for connecting to the Oracle database.
+    host : str
+        The host address for the Oracle server.
+    port : str
+        The port for connecting to the Oracle server.
+    username : str
+        The username for connecting to the Oracle database.
+    password : str
+        The password for the Oracle database.
+    charset : str
+        The charset used for the connection.
+    service : str
+        The Oracle service name.
+    sid : str
+        The Oracle System Identifier (SID).
+    """
+    driver: str
+    dsn: str
+    host: str
+    port: str
+    username: str
+    password: str
+    charset: str
+    service: str
+    sid: str
+
+@dataclass
+class Connections:
+    """
+    Data class to represent all database connections used by the application.
+
+    Attributes
+    ----------
+    sqlite : Sqlite
+        Configuration for the SQLite database connection.
+    mysql : Mysql
+        Configuration for the MySQL database connection.
+    pgsql : Pgsql
+        Configuration for the PostgreSQL database connection.
+    oracle : Oracle
+        Configuration for the Oracle database connection.
+    """
+    sqlite: Sqlite
+    mysql: Mysql
+    pgsql: Pgsql
+    oracle: Oracle
+
+@dataclass
+class Database:
+    """
+    Data class to represent the general database configuration.
+
+    Attributes
+    ----------
+    default : str
+        The name of the default database connection to use.
+    connections : Connections
+        The different database connections available to the application.
+    """
+    default: str
+    connections: Connections

orionis/luminate/config/dataclass/filesystems.py

@@ -0,0 +1,102 @@
+from dataclasses import dataclass
+from typing import Optional
+
+@dataclass
+class Local:
+    """
+    Represents a local filesystem configuration.
+
+    Attributes
+    ----------
+    path : str
+        The absolute or relative path where local files are stored.
+    """
+    path: str
+
+
+@dataclass
+class Public:
+    """
+    Represents a public filesystem configuration.
+
+    Attributes
+    ----------
+    path : str
+        The public-facing path where files are stored.
+    slug : str
+        A unique identifier for the public storage location.
+    """
+    path: str
+    slug: str
+
+
+@dataclass
+class AWSS3:
+    """
+    Represents an AWS S3 storage configuration.
+
+    Attributes
+    ----------
+    driver : str
+        The storage driver (default: 's3').
+    key : str
+        AWS access key ID.
+    secret : str
+        AWS secret access key.
+    region : str
+        AWS region where the bucket is located.
+    bucket : str
+        The S3 bucket name.
+    url : Optional[str], default=None
+        The URL endpoint for accessing the S3 bucket.
+    endpoint : Optional[str], default=None
+        The AWS S3 endpoint URL.
+    use_path_style_endpoint : bool, default=False
+        Whether to use a path-style endpoint.
+    throw : bool, default=False
+        Whether to raise an exception on errors.
+    """
+    key: str = ""
+    secret: str = ""
+    region: str = "us-east-1"
+    bucket: str = ""
+    url: Optional[str] = None
+    endpoint: Optional[str] = None
+    use_path_style_endpoint: bool = False
+    throw: bool = False
+
+
+@dataclass
+class Disks:
+    """
+    Represents the available storage disks.
+
+    Attributes
+    ----------
+    local : Local
+        Configuration for local storage.
+    public : Public
+        Configuration for public storage.
+    s3 : AWSS3
+        Configuration for AWS S3 storage.
+    """
+    local: Local
+    public: Public
+    s3: AWSS3
+
+
+@dataclass
+class Filesystems:
+    """
+    Represents the filesystem configuration, supporting multiple storage disks.
+
+    Attributes
+    ----------
+    default : str
+        The default storage disk to use.
+    disks : Disks
+        A collection of configured storage disks.
+    """
+
+    default: str
+    disks: Disks

orionis/luminate/config/dataclass/logging.py

@@ -0,0 +1,107 @@
+from dataclasses import dataclass
+from typing import Any, Union
+
+@dataclass
+class Single:
+    """
+    Represents a single log file configuration.
+
+    Attributes
+    ----------
+    path : str
+        The file path where the log is stored.
+    level : str
+        The logging level (e.g., 'info', 'error', 'debug').
+    stream : bool
+        Whether to output logs to the console.
+    """
+    path: str
+    level: str
+    stream: bool
+
+
+@dataclass
+class Daily:
+    """
+    Represents a daily log file rotation configuration.
+
+    Attributes
+    ----------
+    path : str
+        The file path where daily logs are stored.
+    level : str
+        The logging level (e.g., 'info', 'error', 'debug').
+    days : int
+        The number of days to retain log files before deletion.
+    stream : bool
+        Whether to output logs to the console.
+    """
+    path: str
+    level: str
+    days: int
+    stream: bool
+
+
+@dataclass
+class Chunked:
+    """
+    Represents a chunked log file configuration.
+
+    This configuration ensures that log files are split into manageable chunks
+    based on size or number of files to prevent excessive file growth.
+
+    Attributes
+    ----------
+    path : str
+        The file path where chunked logs are stored.
+    level : str
+        The logging level (e.g., 'info', 'error', 'debug').
+    max_size : Union[int, str]
+        The maximum file size before creating a new chunk.
+        Can be an integer (bytes) or a string (e.g., '10MB', '500KB').
+    max_files : int
+        The maximum number of log files to retain before older files are deleted.
+    stream : bool
+        Whether to output logs to the console.
+    """
+
+    path: str
+    level: str
+    max_size: Union[int, str]  # Supports both numeric and formatted string sizes ('10MB')
+    max_files: int  # Ensures only a certain number of log files are kept
+    stream: bool
+
+
+@dataclass
+class Channels:
+    """
+    Represents the different logging channels available.
+
+    Attributes
+    ----------
+    single : Single
+        Configuration for single log file storage.
+    daily : Daily
+        Configuration for daily log file rotation.
+    chunked : Chunked
+        Configuration for chunked log file storage.
+    """
+    single: Single
+    daily: Daily
+    chunked: Chunked
+
+
+@dataclass
+class Logging:
+    """
+    Represents the logging system configuration.
+
+    Attributes
+    ----------
+    default : str
+        The default logging channel to use.
+    channels : Channels
+        A collection of available logging channels.
+    """
+    default: str
+    channels: Channels

orionis/luminate/config/dataclass/mail.py

@@ -0,0 +1,81 @@
+from dataclasses import dataclass
+from typing import Optional
+
+@dataclass
+class Smtp:
+    """
+    Represents SMTP (Simple Mail Transfer Protocol) configuration settings.
+
+    Attributes
+    ----------
+    url : str
+        The full URL for the SMTP service.
+    host : str
+        The hostname of the SMTP server (e.g., 'smtp.example.com').
+    port : int
+        The port number used for SMTP communication (e.g., 465, 587).
+    encryption : str
+        The encryption type used for secure communication (e.g., 'SSL', 'TLS', 'None').
+    username : str
+        The username for authentication with the SMTP server.
+    password : str
+        The password for authentication with the SMTP server.
+    timeout : Optional[int], default=None
+        The connection timeout duration in seconds. If None, defaults to the system setting.
+    """
+
+    url: str
+    host: str
+    port: int
+    encryption: str
+    username: str
+    password: str
+    timeout: Optional[int] = None
+
+
+@dataclass
+class File:
+    """
+    Represents email file-based storage configuration.
+
+    Attributes
+    ----------
+    path : str
+        The file path where outgoing emails are stored instead of being sent.
+    """
+
+    path: str
+
+
+@dataclass
+class Mailers:
+    """
+    Represents the available mail transport configurations.
+
+    Attributes
+    ----------
+    smtp : Smtp
+        The SMTP configuration used for sending emails.
+    file : File
+        The file-based mail transport configuration (used for local development/testing).
+    """
+
+    smtp: Smtp
+    file: File
+
+
+@dataclass
+class Mail:
+    """
+    Represents the overall mail configuration.
+
+    Attributes
+    ----------
+    default : str
+        The default mailer transport to use (e.g., 'smtp', 'file').
+    mailers : Mailers
+        The available mail transport configurations.
+    """
+
+    default: str
+    mailers: Mailers

orionis/luminate/config/dataclass/queue.py

@@ -0,0 +1,63 @@
+from dataclasses import dataclass
+
+@dataclass
+class Database:
+    """
+    Represents the configuration for a database-backed queue connection.
+
+    Attributes
+    ----------
+    driver : str
+        The queue driver type (default: 'database').
+    connection : Optional[str]
+        The database connection name used for storing queued jobs.
+    table : str
+        The table where queued jobs are stored.
+    batching : str
+        The table for storing batch job information.
+    failed : str
+        The table for storing failed jobs.
+    queue : str
+        The queue name used for processing jobs.
+    retry_after : int
+        The number of seconds before a job should be retried.
+    after_commit : bool
+        Whether to process jobs only after a successful database transaction commit.
+    """
+    connection: str
+    table: str
+    batching: str
+    failed: str
+    queue: str
+    retry_after: int
+    after_commit: bool
+
+
+@dataclass
+class Connections:
+    """
+    Represents available queue connection configurations.
+
+    Attributes
+    ----------
+    database : DatabaseQueue
+        The configuration for the database-backed queue.
+    """
+
+    database: Database
+
+@dataclass
+class Queue:
+    """
+    Represents the overall queue system configuration.
+
+    Attributes
+    ----------
+    default : str
+        The default queue connection to use.
+    connections : QueueConnections
+        The available queue connection configurations.
+    """
+
+    default: str
+    connections: Connections

orionis/luminate/config/dataclass/session.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass
+from typing import Optional
+
+@dataclass
+class Cookie:
+    """
+    Represents the session cookie configuration.
+
+    Attributes
+    ----------
+    name : str
+        The name of the session cookie.
+    path : str
+        The path for which the session cookie is available.
+    domain : Optional[str]
+        The domain where the session cookie is accessible.
+    secure : Optional[bool]
+        Whether the session cookie should only be sent over HTTPS.
+    http_only : bool
+        Whether the session cookie is only accessible through HTTP (not JavaScript).
+    same_site : str
+        The SameSite policy for the session cookie ('lax', 'strict', or 'none').
+    """
+
+    name: str
+    path: str
+    domain: Optional[str]
+    secure: Optional[bool]
+    http_only: bool
+    same_site: str
+
+
+@dataclass
+class Session:
+    """
+    Represents the session management configuration.
+
+    Attributes
+    ----------
+    driver : str
+        The session driver type (e.g., 'file', 'database', 'redis').
+    lifetime : int
+        The session lifetime in minutes before expiration.
+    expire_on_close : bool
+        Whether the session expires when the browser is closed.
+    encrypt : bool
+        Whether session data should be encrypted for additional security.
+    files : str
+        The file path where session data is stored when using the 'file' driver.
+    cookie : SessionCookie
+        The configuration settings for the session cookie.
+    """
+
+    driver: str
+    lifetime: int
+    expire_on_close: bool
+    encrypt: bool
+    files: str
+    cookie: Cookie