rpa-suite 1.4.0__py3-none-any.whl → 1.4.2__py3-none-any.whl

rpa_suite/__init__.py

@@ -1,4 +1,60 @@
 # rpa_suite/__init__.py
+"""
+    RPA Suite is a Python module that provides a set of tools for process automation.
+    
+    To use the module, import it as follows:
+        >>> from rpa_suite import rpa
+    
+    Example of usage:
+        >>> from rpa_suite import rpa
+        >>> rpa.email.send_smtp(
+        ...     email_user="your@email.com",
+        ...     email_password="your_password",
+        ...     email_to="destination@email.com",
+        ...     subject_title="Test",
+        ...     body_message="<p>Test message</p>"
+        ... )
+        >>> rpa.alert_print("Hello World")
+    
+    Available modules:
+        ``clock``: Utilities for time and stopwatch manipulation
+        ``date``: Functions for date manipulation
+        ``email``: Functionalities for sending emails via SMTP
+        ``directory``: Operations with directories
+        ``file``: File manipulation
+        ``log``: Logging system
+        ``printer``: Functions for formatted output
+        ``regex``: Operations with regular expressions
+        ``validate``: Data validation functions
 
-from .suite import Suite as rpa
-rpa = rpa()
+    pt-br
+    -----
+    RPA Suite é um módulo Python que fornece um conjunto de ferramentas para automação de processos.
+    
+    Para utilizar o módulo, importe-o da seguinte forma:
+        >>> from rpa_suite import rpa
+    
+    Exemplo de uso:
+        >>> from rpa_suite import rpa
+        >>> rpa.email.send_smtp(
+        ...     email_user="seu@email.com",
+        ...     email_password="sua_senha",
+        ...     email_to="destino@email.com",
+        ...     subject_title="Teste",
+        ...     body_message="<p>Mensagem de teste</p>"
+        ... )
+        >>> rpa.alert_print("Hello World")
+    
+    Módulos disponíveis:
+        ``clock``: Utilitários para manipulação de tempo e cronômetro
+        ``date``: Funções para manipulação de datas
+        ``email``: Funcionalidades para envio de emails via SMTP
+        ``directory``: Operações com diretórios
+        ``file``: Manipulação de arquivos
+        ``log``: Sistema de logging
+        ``printer``: Funções para output formatado
+        ``regex``: Operações com expressões regulares
+        ``validate``: Funções de validação de dados
+"""
+
+from .suite import Suite as rpa

rpa_suite/core/__init__.py

@@ -1 +1,27 @@
-# rpa_suite/core/__init__.py
+# rpa_suite/core/__init__.py
+
+"""
+The Core module is where we can import all Sub-Objects used by the rpa_suite module separately, categorized by their respective classes based on functionality. However, we can also use them through the main rpa object using the following syntax:
+>>> from rpa_suite import rpa
+>>> rpa.clock.wait_for_exec()
+>>> rpa.file.screen_shot() ...
+among others.
+
+pt-br
+----------
+O módulo Core é de onde podemos importar todos os Sub-Objetos usados pelo módulo rpa_suite de forma separada, categorizados por suas respectivas classes com base na funcionalidade. No entanto, também podemos usá-los através do objeto principal rpa usando a seguinte sintaxe:
+>>> from rpa_suite import rpa
+>>> rpa.clock.wait_for_exec()
+>>> rpa.file.screen_shot() ...
+entre outros.
+
+"""
+from .clock import Clock
+from .date import Date
+from .dir import Directory
+from .email import Email
+from .file import File
+from .log import Log
+from .print import Print
+from .regex import Regex
+from .validate import Validate

rpa_suite/core/clock.py

@@ -7,12 +7,44 @@ from typing import Callable, Any
 
 
 class Clock():
+    
+    """
+    Class that provides utilities for time manipulation and stopwatch.
+    
+    This class offers functionalities for:
+        - Timed function execution
+        - Execution time control
+        - Task scheduling
+        
+    Methods:
+        exec_at_hour: Executes a function at a specific time
+        
+    The Clock class is part of RPA Suite and can be accessed through the rpa object:
+        >>> from rpa_suite import rpa
+        >>> rpa.clock.exec_at_hour("14:30", my_function)
+
+    pt-br
+    ----------
+    Classe que fornece utilitários para manipulação de tempo e cronômetro.
+    
+    Esta classe oferece funcionalidades para:
+        - Execução temporizada de funções
+        - Controle de tempo de execução
+        - Agendamento de tarefas
+        
+    Métodos:
+        exec_at_hour: Executa uma função em um horário específico
+        
+    A classe Clock é parte do RPA Suite e pode ser acessada através do objeto rpa:
+        >>> from rpa_suite import rpa
+        >>> rpa.clock.exec_at_hour("14:30", minha_funcao)
+    """
 
     def __init__(self):
         ...
-    
+
     def exec_at_hour(self,
-                hour_to_exec: str,
+                hour_to_exec: str | None,
                 fn_to_exec: Callable[..., Any],
                 *args,
                 **kwargs,
@@ -160,7 +192,8 @@ class Clock():
         >>> wait_for_exec(30, sum, 10, 5) -> 15 \n
             * NOTE:  `wait_for_exec` receives as first argument the time to wait (sec), then the function `sum` and finally the arguments that the function will use.
             
-        Description: pt-br
+        
+        pt-br
         ----------    
         Função temporizadora, aguardar um valor em ``segundos`` para executar a função do argumento.
         
@@ -227,8 +260,9 @@ class Clock():
         We have a sum function in the following format ``sum(a, b) -> return x``, where ``x`` is the result of the sum. We want to execute the sum and then wait `30 seconds` to continue the main code:
         >>> wait_for_exec(30, sum, 10, 5) -> 15 \n
             * NOTE:  `wait_for_exec` receives as first argument the time to wait (sec), then the function `sum` and finally the arguments that the function will use.
-            
-        Description: pt-br
+        
+        
+        pt-br
         ----------
         Função temporizadora, executa uma função e aguarda o tempo em ``segundos``
         

rpa_suite/core/date.py

@@ -6,7 +6,37 @@ from typing import Tuple
 from rpa_suite.functions._printer import error_print
 
 class Date():
+    """
+    Class that provides utilities for date manipulation and formatting.
     
+    This class offers functionalities for:
+        - Getting current time components (hours, minutes, seconds)
+        - Date formatting and manipulation
+        - Date validation and conversion
+        
+    Methods:
+        get_hms: Returns current time as tuple of hour, minute, second
+        
+    The Date class is part of RPA Suite and can be accessed through the rpa object:
+        >>> from rpa_suite import rpa
+        >>> hour, minute, second = rpa.date.get_hms()
+
+    pt-br
+    ----------
+    Classe que fornece utilitários para manipulação e formatação de datas.
+    
+    Esta classe oferece funcionalidades para:
+        - Obtenção de componentes do tempo atual (horas, minutos, segundos)
+        - Formatação e manipulação de datas
+        - Validação e conversão de datas
+        
+    Métodos:
+        get_hms: Retorna o horário atual como tupla de hora, minuto, segundo
+        
+    A classe Date é parte do RPA Suite e pode ser acessada através do objeto rpa:
+        >>> from rpa_suite import rpa
+        >>> hora, minuto, segundo = rpa.date.get_hms()
+    """
     def __init__(self):
         ...
 

rpa_suite/core/dir.py

@@ -5,7 +5,49 @@ from rpa_suite.functions._printer import error_print, alert_print, success_print
 
 
 class Directory():
-    
+
+    """
+    Class that provides utilities for directory management, including creating, deleting, and manipulating directories.
+
+    This class offers functionalities for:
+        - Creating temporary directories
+        - Deleting directories
+        - Checking if a directory exists
+        - Listing files in a directory
+
+    Methods:
+        create_temp_dir: Creates a temporary directory for file operations.
+        
+    The Directory class is part of RPA Suite and can be accessed through the rpa object:
+        >>> from rpa_suite import rpa
+        >>> rpa.directory.create_temp_dir(path_to_create='my_folder', name_temp_dir='temp_dir')
+
+    Parameters:
+        path_to_create (str): The full path where the temporary directory should be created. Default is 'default', which creates it in the current directory.
+        name_temp_dir (str): The name of the temporary directory to be created. Default is 'temp'.
+
+    pt-br
+    ----------
+    Classe que fornece utilitários para gerenciamento de diretórios, incluindo criação, exclusão e manipulação de diretórios.
+
+    Esta classe oferece funcionalidades para:
+        - Criar diretórios temporários
+        - Excluir diretórios
+        - Verificar se um diretório existe
+        - Listar arquivos em um diretório
+
+    Métodos:
+        create_temp_dir: Cria um diretório temporário para operações com arquivos.
+        
+    A classe Directory é parte do RPA Suite e pode ser acessada através do objeto rpa:
+        >>> from rpa_suite import rpa
+        >>> rpa.directory.create_temp_dir(path_to_create='minha_pasta', name_temp_dir='temp_dir')
+
+    Parâmetros:
+        path_to_create (str): O caminho completo onde o diretório temporário deve ser criado. O padrão é 'default', que o cria no diretório atual.
+        name_temp_dir (str): O nome do diretório temporário a ser criado. O padrão é 'temp'.
+    """
+
     def __init__(self):
         ...
 

rpa_suite/core/email.py

@@ -12,6 +12,64 @@ from rpa_suite.core.validate import email_validator
 
 class Email():
     
+    """
+    Class that provides utilities for sending emails via SMTP protocol.
+    
+    This class offers functionalities for:
+        - Sending emails with attachments
+        - HTML message formatting
+        - SMTP server configuration
+        - Email validation
+        
+    Methods:
+        send_smtp: Sends an email through specified SMTP server
+        
+    The Email class is part of RPA Suite and can be accessed through the rpa object:
+        >>> from rpa_suite import rpa
+        >>> rpa.email.send_smtp(
+        ...     email_user="your@email.com",
+        ...     email_password="your_password",
+        ...     email_to="destination@email.com",
+        ...     subject_title="Test",
+        ...     body_message="<p>Test message</p>"
+        ... )
+
+    Parameters:
+        smtp_server (str): SMTP server address
+        smtp_port (str): SMTP server port
+        email_user (str): Email for SMTP authentication
+        email_password (str): Password for SMTP authentication
+        email_to (str): Recipient email address
+        attachments (list[str]): List of file paths to attach
+        subject_title (str): Email subject
+        body_message (str): Email body in HTML format
+        auth_tls (bool): Whether to use TLS authentication
+
+    pt-br
+    ----------
+    Classe que fornece utilitários para envio de emails via protocolo SMTP.
+    
+    Esta classe oferece funcionalidades para:
+        - Envio de emails com anexos
+        - Formatação de mensagens em HTML
+        - Configuração de servidor SMTP
+        - Validação de email
+        
+    Métodos:
+        send_smtp: Envia um email através do servidor SMTP especificado
+        
+    A classe Email é parte do RPA Suite e pode ser acessada através do objeto rpa:
+        >>> from rpa_suite import rpa
+        >>> rpa.email.send_smtp(
+        ...     email_user="seu@email.com",
+        ...     email_password="sua_senha",
+        ...     email_to="destino@email.com",
+        ...     subject_title="Teste",
+        ...     body_message="<p>Mensagem de teste</p>"
+        ... )
+    """
+
+
     smtp_server:str = "smtp.hostinger.com",
     smtp_port:str = 465,
     email_user:str = "your_email@email.com",
@@ -22,6 +80,7 @@ class Email():
     body_message: str = '<p>Testing message body</p>'
     auth_tls: bool = False,
 
+
     def __init__(self):
         ...
 
@@ -40,28 +99,54 @@ class Email():
         ):
 
         """
-        Envia um e-mail utilizando o servidor SMTP especificado.
+        Sends an email using the specified SMTP server.
+
+        Args:
+            smtp_server (str, optional): Address of the SMTP server. 
+                Default: "smtp.hostinger.com".
+            smtp_port (str, optional): Port of the SMTP server. 
+                Default: 465.
+            email_user (str, optional): User (email) for authentication on the SMTP server. 
+                Default: "example@email.com".
+            email_password (str, optional): Password for authentication on the SMTP server. 
+                Default: "example123".
+            email_to (str, optional): Email address of the recipient. 
+                Default: "person@email.com".
+            attachments (list[str], optional): List of file paths to attach to the email. 
+                Default: [].
+            subject_title (str, optional): Title (subject) of the email. 
+                Default: 'test title'.
+            body_message (str, optional): Body of the email message, in HTML format. 
+                Default: '<p>test message</p>'.
+
+        Returns:
+            None: This function does not explicitly return any value, but prints success or failure messages when sending the email.
+        
+        pt-br
+        ------
+        
+        Envia um email usando o servidor SMTP especificado.
 
         Args:
-            smtp_server (str, optional): Endereço do servidor SMTP. 
+            smtp_server (str, opcional): Endereço do servidor SMTP. 
                 Padrão: "smtp.hostinger.com".
-            smtp_port (str, optional): Porta do servidor SMTP. 
+            smtp_port (str, opcional): Porta do servidor SMTP. 
                 Padrão: 465.
-            email_user (str, optional): Usuário (e-mail) para autenticação no servidor SMTP. 
-                Padrão: "bot@vettracode.com".
-            email_password (str, optional): Senha para autenticação no servidor SMTP. 
-                Padrão: "Bot@#2025".
-            email_to (str, optional): Endereço de e-mail do destinatário. 
-                Padrão: "camilo.costa1993@gmail.com".
-            attachments (list[str], optional): Lista de caminhos de arquivos para anexar ao e-mail. 
+            email_user (str, opcional): Usuário (email) para autenticação no servidor SMTP. 
+                Padrão: "example@email.com".
+            email_password (str, opcional): Senha para autenticação no servidor SMTP. 
+                Padrão: "example123".
+            email_to (str, opcional): Endereço de email do destinatário. 
+                Padrão: "person@email.com".
+            attachments (list[str], opcional): Lista de caminhos de arquivos para anexar ao email. 
                 Padrão: [].
-            subject_title (str, optional): Título (assunto) do e-mail. 
-                Padrão: 'titulo teste'.
-            body_message (str, optional): Corpo da mensagem do e-mail, em formato HTML. 
+            subject_title (str, opcional): Título (assunto) do email. 
+                Padrão: 'título de teste'.
+            body_message (str, opcional): Corpo da mensagem do email, em formato HTML. 
                 Padrão: '<p>mensagem de teste</p>'.
 
         Returns:
-            None: Esta função não retorna nenhum valor explicitamente, mas imprime mensagens de sucesso ou falha no envio do e-mail.
+            Nenhum: Esta função não retorna explicitamente nenhum valor, mas imprime mensagens de sucesso ou falha ao enviar o email.
         """
 
         try:

rpa_suite/core/file.py

@@ -6,6 +6,55 @@ from colorama import Fore
 from typing import Dict, List, Union
 
 class File():
+    """
+    Class that provides utilities for file management, including creation, deletion, and manipulation of files.
+
+    This class offers functionalities for:
+        - Creating and deleting flag files
+        - Counting files in a directory
+        - Capturing screenshots and managing their paths
+
+    Methods:
+        screen_shot: Creates a screenshot and saves it in a specified directory
+        count_files: Counts the number of files in a specified directory
+        flag_create: Creates a flag file
+        flag_delete: Deletes a flag file
+
+    The File class is part of the RPA Suite and can be accessed through the rpa object:
+        >>> from rpa_suite import rpa
+        >>> rpa.file.screen_shot('example')
+
+    Parameters:
+        file_name (str): The name of the screenshot file
+        path_dir (str): The path of the directory where the screenshot should be saved
+        save_with_date (bool): Indicates if the file name should include the date
+        delay (int): The wait time before capturing the screen
+
+    pt-br
+    ----------
+    Classe que fornece utilitários para gerenciamento de arquivos, incluindo criação, exclusão e manipulação de arquivos.
+
+    Esta classe oferece funcionalidades para:
+        - Criar e excluir arquivos de flag
+        - Contar arquivos em um diretório
+        - Capturar screenshots e gerenciar seus caminhos
+
+    Métodos:
+        screen_shot: Cria uma captura de tela e a salva em um diretório especificado
+        count_files: Conta o número de arquivos em um diretório especificado
+        flag_create: Cria um arquivo de flag
+        flag_delete: Exclui um arquivo de flag
+
+    A classe File é parte do RPA Suite e pode ser acessada através do objeto rpa:
+        >>> from rpa_suite import rpa
+        >>> rpa.file.screen_shot('exemplo')
+
+    Parâmetros:
+        file_name (str): O nome do arquivo de captura de tela
+        path_dir (str): O caminho do diretório onde a captura de tela deve ser salva
+        save_with_date (bool): Indica se o nome do arquivo deve incluir a data
+        delay (int): O tempo de espera antes de capturar a tela
+    """
     
     def __init__(self):
         self.__create_ss_dir = create_ss_dir
@@ -16,7 +65,7 @@ class File():
                     save_with_date: bool = True,
                     delay: int = 1, 
                     use_default_path_and_name: bool = True,
-                    name_ss_dir:str = None,
+                    name_ss_dir:str | None = None,
                     display_message: bool = False) -> str | None:
 
         """
@@ -24,10 +73,13 @@ class File():
 
         Parameters:
         ----------
-        ``file_path: str`` - should be a string, not have a default path.
         ``file_name: str`` - should be a string, by default name is `screenshot`.
+        ``path_dir: str`` - should be a string, not have a default path.
         ``save_with_date: bool`` - should be a boolean, by default `True` save namefile with date `foo_dd_mm_yyyy-hh_mm_ss.png`.
         ``delay: int`` - should be a int, by default 1 (represents seconds).
+        ``use_default_path_and_name: bool`` - should be a boolean, by default `True`
+        ``name_ss_dir: str`` - should be a string, by default type `None`
+        ``display_message`` - should be a boolean, by default `False`
 
         Return:
         ----------
@@ -40,10 +92,13 @@ class File():
 
         Parâmetros:
         ----------
-        ``file_path: str`` - deve ser uma string, não tem um caminho padrão.
         ``file_name: str`` - deve ser uma string, por padrão o nome é `screenshot`.
+        ``file_path: str`` - deve ser uma string, não tem um caminho padrão.
         ``save_with_date: bool`` - deve ser um booleano, por padrão `True` salva o nome do arquivo com a data `foo_dd_mm_yyyy-hh_mm_ss.png`.
         ``delay: int`` - deve ser um int, por padrão 1 representado em segundo(s).
+        ``use_default_path_and_name: bool`` - deve ser um booleano, por padrão `True`
+        ``name_ss_dir: str`` - deve ser uma string, por padrão do tipo `None`
+        ``display_message`` - deve ser um booleano, por padrão `False`
         
         Retorno:
         ----------
@@ -101,7 +156,7 @@ class File():
 
     def flag_create(self,
                     name_file: str = 'running.flag',
-                    path_to_create: str = None,
+                    path_to_create: str | None = None,
                     display_message: bool = True) -> None:
         """
         Cria um arquivo de sinalização indicando que o robô está em execução.
@@ -124,7 +179,7 @@ class File():
 
     def flag_delete(self,
                     name_file: str = 'running.flag',
-                    path_to_delete: str = None,
+                    path_to_delete: str | None = None,
                     display_message: bool = True,) -> None:
         
         """
@@ -193,7 +248,7 @@ class File():
         # Process
         try:
             for dir in dir_to_count:
-                for current_dir, sub_dir, files in os.walk(dir):
+                for _, _, files in os.walk(dir):
                     for file in files:
                         if type_extension == '*' or file.endswith(f'.{type_extension}'):
                             result['qt'] += 1

rpa_suite/core/log.py

@@ -6,6 +6,38 @@ import sys, os, inspect
 
 
 class Filters():
+    """
+    Class that provides utilities for filtering log messages based on specific keywords.
+
+    This class allows you to define a list of words that, if found in a log message, will trigger a modification of that message. 
+    The modified message will indicate that it has been altered due to the presence of a filtered word.
+
+    Methods:
+        __call__: Checks if any of the specified words are present in the log message and alters the message if a match is found.
+
+    Example:
+        >>> filter = Filters()
+        >>> filter.word_filter = ['error', 'warning']
+        >>> record = {"message": "This is an error message."}
+        >>> filter(record)  # This will alter the message to 'Log Alterado devido a palavra Filtrada!'
+
+    pt-br
+    ----------
+    Classe que fornece utilitários para filtrar mensagens de log com base em palavras-chave específicas.
+
+    Esta classe permite que você defina uma lista de palavras que, se encontradas em uma mensagem de log, acionarão uma modificação dessa mensagem. 
+    A mensagem modificada indicará que foi alterada devido à presença de uma palavra filtrada.
+
+    Métodos:
+        __call__: Verifica se alguma das palavras especificadas está presente na mensagem de log e altera a mensagem se uma correspondência for encontrada.
+
+    Exemplo:
+        >>> filtro = Filters()
+        >>> filtro.word_filter = ['erro', 'aviso']
+        >>> registro = {"message": "Esta é uma mensagem de erro."}
+        >>> filtro(registro)  # Isso alterará a mensagem para 'Log Alterado devido a palavra Filtrada!'
+    """
+
     word_filter: Op[list[str]]
 
     def __call__(self, record):
@@ -25,6 +57,35 @@ class Filters():
 
 
 class CustomHandler():
+    """
+    Class that provides a custom logging handler to manage log messages.
+    
+    This class allows for the formatting and writing of log messages to a specified output. 
+    It utilizes a custom formatter to structure the log messages, including details such as 
+    the time of logging, log level, and the message itself.
+
+    Methods:
+        write: Writes the formatted log message to the output.
+
+    Example:
+        >>> handler = CustomHandler(formatter=CustomFormatter())
+        >>> handler.write({"time": "12:00", "level": "INFO", "message": "This is a log message."})
+
+    pt-br
+    ----------
+    Classe que fornece um manipulador de log personalizado para gerenciar mensagens de log.
+    
+    Esta classe permite a formatação e escrita de mensagens de log em uma saída especificada. 
+    Ela utiliza um formatador personalizado para estruturar as mensagens de log, incluindo detalhes como 
+    o horário do log, nível de log e a própria mensagem.
+
+    Métodos:
+        write: Escreve a mensagem de log formatada na saída.
+
+    Exemplo:
+        >>> manipulador = CustomHandler(formatter=CustomFormatter())
+        >>> manipulador.write({"time": "12:00", "level": "INFO", "message": "Esta é uma mensagem de log."})
+    """
     def __init__(self, formatter):
         self.formatter = formatter
 
@@ -35,6 +96,47 @@ class CustomHandler():
 
 
 class CustomFormatter:
+    """
+    Class that provides a custom formatter for log messages.
+    
+    This class is responsible for formatting log messages in a structured way, 
+    allowing for easy readability and understanding of log entries. It formats 
+    the log messages to include details such as the time of logging, log level, 
+    the filename, line number, and the actual log message.
+
+    Methods:
+        format: Formats the log message based on the provided record.
+
+    Example:
+        >>> formatter = CustomFormatter()
+        >>> log_message = formatter.format({
+        ...     "time": "12:00",
+        ...     "level": "INFO",
+        ...     "message": "This is a log message."
+        ... })
+        >>> print(log_message)
+
+    pt-br
+    ----------
+    Classe que fornece um formatador personalizado para mensagens de log.
+    
+    Esta classe é responsável por formatar mensagens de log de maneira estruturada, 
+    permitindo fácil leitura e compreensão das entradas de log. Ela formata 
+    as mensagens de log para incluir detalhes como o horário do log, nível de log, 
+    o nome do arquivo, número da linha e a mensagem de log real.
+
+    Métodos:
+        format: Formata a mensagem de log com base no registro fornecido.
+
+    Exemplo:
+        >>> formatador = CustomFormatter()
+        >>> mensagem_log = formatador.format({
+        ...     "time": "12:00",
+        ...     "level": "INFO",
+        ...     "message": "Esta é uma mensagem de log."
+        ... })
+        >>> print(mensagem_log)
+    """
     def format(self, record):
 
         frame = inspect.currentframe().f_back
@@ -64,6 +166,36 @@ class CustomFormatter:
 
 
 class Log():
+
+    """
+    Class that provides utilities for logging messages in a structured manner.
+    
+    This class is responsible for managing log entries, allowing for easy tracking 
+    and debugging of application behavior. It supports various logging levels and 
+    can be configured to log messages to different outputs, such as files or the console.
+
+    Methods:
+        config_logger: Configures the logger with specified parameters.
+        
+    Example:
+        >>> logger = Log()
+        >>> logger.config_logger(path_dir='logs', name_log_dir='my_logs', name_file_log='app_log')
+    
+    pt-br
+    ----------
+    Classe que fornece utilitários para registrar mensagens de forma estruturada.
+    
+    Esta classe é responsável por gerenciar entradas de log, permitindo fácil rastreamento 
+    e depuração do comportamento da aplicação. Suporta vários níveis de log e 
+    pode ser configurada para registrar mensagens em diferentes saídas, como arquivos ou console.
+
+    Métodos:
+        config_logger: Configura o logger com parâmetros especificados.
+        
+    Exemplo:
+        >>> logger = Log()
+        >>> logger.config_logger(path_dir='logs', name_log_dir='meus_logs', name_file_log='log_app')
+    """
     
     filters: Filters
     custom_handler: CustomHandler
@@ -81,6 +213,10 @@ class Log():
                         filter_words: list[str] = None):
 
         """
+        Função responsável por criar um objeto logger com fileHandler e streamHandler
+        
+        pt-br
+        ----------
         Function responsible for create a object logger with fileHandler and streamHandler
         """
 
@@ -133,6 +269,10 @@ class Log():
 
         """
         Function responsable to generate ``start run log level debug``, in file and print on terminal the same log captured on this call.
+        
+        pt-br
+        ----------
+        Função responsável por gerar o nível de log ``início execução nível debug``, em arquivo e imprimir no terminal o mesmo log capturado nesta chamada.
         """
 
         file_h: False
@@ -178,6 +318,10 @@ class Log():
 
         """
         Function responsable to generate log level ``debug``, in file and print on terminal the same log captured on this call.
+        
+        pt-br
+        -----
+        Função responsável por gerar o nível de log ``debug``, em arquivo e imprimir no terminal o mesmo log capturado nesta chamada.
         """
 
         try:
@@ -204,6 +348,10 @@ class Log():
 
         """
         Function responsable to generate log level ``info``, in file and print on terminal the same log captured on this call.
+        
+        pt-br
+        -----
+        Função responsável por gerar o nível de log ``info``, em arquivo e imprimir no terminal o mesmo log capturado nesta chamada.
         """
 
         try:
@@ -229,6 +377,10 @@ class Log():
 
         """
         Function responsable to generate log level ``warning``, in file and print on terminal the same log captured on this call.
+        
+        pt-br
+        -----
+        Função responsável por gerar o nível de log ``aviso``, em arquivo e imprimir no terminal o mesmo log capturado nesta chamada.
         """
 
         try:
@@ -256,6 +408,10 @@ class Log():
 
         """
         Function responsable to generate log level ``error``, in file and print on terminal the same log captured on this call.
+        
+        pt-br
+        -----
+        Função responsável por gerar o nível de log ``erro``, em arquivo e imprimir no terminal o mesmo log capturado nesta chamada.
         """
 
         try:
@@ -282,6 +438,11 @@ class Log():
 
         """
         Function responsable to generate log level ``critical``, in file and print on terminal the same log captured on this call.
+        
+        pt-br
+        ----------
+        
+        Função responsável por gerar o nível de log ``crítico``, em arquivo e imprimir no terminal o mesmo log capturado nesta chamada.
         """
 
         try:

rpa_suite/core/print.py

@@ -19,6 +19,38 @@ class Colors():
 
 class Print():
     
+    """
+    Class that provides methods for formatted printing in the console, allowing for different types of messages to be displayed with specific colors.
+
+    This class offers functionalities for:
+        - Printing success messages in green
+        - Printing alert messages in yellow
+        - Additional printing methods can be added for other message types
+
+    The Print class is part of the RPA Suite and can be used to enhance the visibility of console outputs.
+
+    Example:
+    ----------
+        >>> from rpa_suite import rpa
+        >>> rpa.alert_print('Hello World')
+    
+    pt-br
+    ----
+
+    Classe que fornece métodos para impressão formatada no console, permitindo que diferentes tipos de mensagens sejam exibidas com cores específicas.
+
+    Esta classe oferece funcionalidades para:
+        - Imprimir mensagens de sucesso em verde
+        - Imprimir mensagens de alerta em amarelo
+        - Métodos de impressão adicionais podem ser adicionados para outros tipos de mensagens
+
+    A classe Print é parte do RPA Suite e pode ser usada para aumentar a visibilidade das saídas do console.
+
+    Exemplo de uso:
+    ----------
+    >>> from rpa_suite import rpa
+    >>> rpa.alert_print('Hello World')
+    """
     colors: Colors = Colors
     
     def __init__(self):

rpa_suite/core/regex.py

@@ -3,7 +3,25 @@ import re
 from rpa_suite.functions._printer import error_print, success_print
 
 class Regex():
-    
+    """
+    Class that provides utilities for working with regular expressions.
+
+    This class offers functionalities for:
+        - Searching for patterns in text
+        - Validating strings against specific patterns
+
+    The Regex class is part of the RPA Suite and can be used to enhance text processing capabilities.
+
+    pt-br
+    ----------
+    Classe que fornece utilitários para trabalhar com expressões regulares.
+
+    Esta classe oferece funcionalidades para:
+        - Buscar padrões em texto
+        - Validar strings contra padrões específicos
+
+    A classe Regex é parte do RPA Suite e pode ser usada para aprimorar as capacidades de processamento de texto.
+    """
     def __init__(self):
         ...
     

rpa_suite/core/validate.py

@@ -5,7 +5,29 @@ from rpa_suite.functions._printer import error_print, success_print
 
 
 class Validate():
-    
+
+    """
+    Class responsible for validating email addresses and searching for words within text.
+
+    This class offers functionalities to:
+        - Validate a list of emails, checking if each one complies with email formatting standards.
+        - Search for specific words or patterns within a given text, providing information about their occurrences.
+        - Return a dictionary with information about the validity of the emails, including lists of valid and invalid emails, as well as counts for each category.
+
+    The class uses the email_validator library to perform rigorous validation of email addresses, ensuring that the provided data is correct and ready for use in applications that require email communication. Additionally, it provides methods for searching words in text, enhancing its utility for text processing.
+
+    pt-br
+    ----
+    Classe responsável pela validação de endereços de e-mail e pela busca de palavras dentro de textos.
+
+    Esta classe oferece funcionalidades para:
+        - Validar uma lista de e-mails, verificando se cada um deles está em conformidade com os padrões de formatação de e-mail.
+        - Buscar palavras ou padrões específicos dentro de um texto fornecido, fornecendo informações sobre suas ocorrências.
+        - Retornar um dicionário com informações sobre a validade dos e-mails, incluindo listas de e-mails válidos e inválidos, bem como contagens de cada categoria.
+
+    A classe utiliza a biblioteca email_validator para realizar a validação rigorosa dos endereços de e-mail, garantindo que os dados fornecidos estejam corretos e prontos para uso em aplicações que requerem comunicação via e-mail. Além disso, fornece métodos para busca de palavras em textos, aumentando sua utilidade para o processamento de texto.
+    """
+        
     def __init__(self):
         ...
             

rpa_suite/suite.py

@@ -9,8 +9,47 @@ from .core.regex import Regex
 from .core.validate import Validate
 from colorama import Fore
 
+
 # Windows bash colors
 class Colors():
+
+    """
+    This class provides color constants based on the colorama library,
+    allowing for visual formatting of texts in the Windows terminal.
+    
+    Attributes:
+        black (str): Black color
+        blue (str): Blue color
+        green (str): Green color
+        cyan (str): Cyan color
+        red (str): Red color
+        magenta (str): Magenta color
+        yellow (str): Yellow color
+        white (str): White color
+        default (str): Default color (white)
+        call_fn (str): Light magenta color (used for function calls)
+        retur_fn (str): Light yellow color (used for function returns)
+
+    pt-br
+    ------
+    
+    Esta classe fornece constantes de cores baseadas na biblioteca colorama,
+    permitindo a formatação visual de textos no terminal Windows.
+    
+    Atributos:
+        black (str): Cor preta
+        blue (str): Cor azul
+        green (str): Cor verde
+        cyan (str): Cor ciano
+        red (str): Cor vermelha
+        magenta (str): Cor magenta
+        yellow (str): Cor amarela
+        white (str): Cor branca
+        default (str): Cor padrão (branca)
+        call_fn (str): Cor magenta clara (usada para chamadas de função)
+        retur_fn (str): Cor amarela clara (usada para retornos de função)
+    """
+
     black     = f'{Fore.BLACK}'
     blue      = f'{Fore.BLUE}'
     green     = f'{Fore.GREEN}'
@@ -24,6 +63,64 @@ class Colors():
     retur_fn  = f'{Fore.LIGHTYELLOW_EX}'
 
 class Suite():
+
+    """
+    RPA Suite is a Python module that provides a set of tools for process automation.
+    
+    To use the module, import it as follows:
+        >>> from rpa_suite import rpa
+    
+    Example of usage:
+        >>> from rpa_suite import rpa
+        >>> rpa.email.send_smtp(
+        ...     email_user="your@email.com",
+        ...     email_password="your_password",
+        ...     email_to="destination@email.com",
+        ...     subject_title="Test",
+        ...     body_message="<p>Test message</p>"
+        ... )
+        >>> rpa.alert_print("Hello World")
+    
+    Available modules:
+        ``clock``: Utilities for time and stopwatch manipulation
+        ``date``: Functions for date manipulation
+        ``email``: Functionalities for sending emails via SMTP
+        ``directory``: Operations with directories
+        ``file``: File manipulation
+        ``log``: Logging system
+        ``printer``: Functions for formatted output
+        ``regex``: Operations with regular expressions
+        ``validate``: Data validation functions
+
+    pt-br
+    -----
+    RPA Suite é um módulo Python que fornece um conjunto de ferramentas para automação de processos.
+    
+    Para utilizar o módulo, importe-o da seguinte forma:
+        >>> from rpa_suite import rpa
+    
+    Exemplo de uso:
+        >>> from rpa_suite import rpa
+        >>> rpa.email.send_smtp(
+        ...     email_user="seu@email.com",
+        ...     email_password="sua_senha",
+        ...     email_to="destino@email.com",
+        ...     subject_title="Teste",
+        ...     body_message="<p>Mensagem de teste</p>"
+        ... )
+        >>> rpa.alert_print("Hello World")
+    
+    Módulos disponíveis:
+        ``clock``: Utilitários para manipulação de tempo e cronômetro
+        ``date``: Funções para manipulação de datas
+        ``email``: Funcionalidades para envio de emails via SMTP
+        ``directory``: Operações com diretórios
+        ``file``: Manipulação de arquivos
+        ``log``: Sistema de logging
+        ``printer``: Funções para output formatado
+        ``regex``: Operações com expressões regulares
+        ``validate``: Funções de validação de dados
+    """
     
     clock: Clock = Clock()
     date: Date = Date()
@@ -37,7 +134,7 @@ class Suite():
     
     def __init__(self):
         ...
-
+    
     def success_print(self,
                         string_text: str,
                         color=Colors.green,

{rpa_suite-1.4.0.dist-info → rpa_suite-1.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rpa_suite
-Version: 1.4.0
+Version: 1.4.2
 Summary: Conjunto de ferramentas essenciais para Automação RPA com Python, que facilitam o dia a dia de desenvolvimento.
 Author: Camilo Costa de Carvalho
 Author-email: camilo.carvalho@triasoftware.com.br
@@ -186,7 +186,7 @@ Lançamento: *20/02/2024*
 
 Status: Em desenvolvimento.
 
-### Notas da atualização: 1.4.0
+### Notas da atualização: 1.4.2
 
 - Correções de bugs em diversas funções relacionadas a tempo: *exec_at_hour* , *wait_for_exec* , *exec_and_wait*
 - Correções de bugs com tempo superior a 10 minutos nas funções de data: *get_hms* e *get_dma*

rpa_suite-1.4.2.dist-info/RECORD

@@ -0,0 +1,25 @@
+rpa_suite/__init__.py,sha256=BDRCB6CggcWSh2wOgPuxL5iPDRRYuPibTaEG7eLMyhc,2297
+rpa_suite/suite.py,sha256=WnCJ-AZ99NxnoS10E7_qX_0eg886B2IDekj6Cl1HFVA,10110
+rpa_suite/core/__init__.py,sha256=1XkytWVpVwyP8Dmm4UsXE625P5i7MOOXJBsQOPfCqiE,1046
+rpa_suite/core/clock.py,sha256=sTaYknZo46-L199k3utQdJ2b2IyL7FEkQu_dgwbdVMo,13800
+rpa_suite/core/date.py,sha256=PBU999Acxiwoep029ElqKSzK6T4DrF3eIP-LB_J-BbM,6568
+rpa_suite/core/dir.py,sha256=y6YDyRYQdf9Bj0z3Gs6ugNZ0tKWYgWdDI5R5BjjRIEY,9783
+rpa_suite/core/email.py,sha256=kQJAc6Nb9y7jo-oBAo8X1EZS2y-_gTJRoRc9ylS04CE,8675
+rpa_suite/core/file.py,sha256=xuXaV_jon8hJ1Fb2j5DukXfnAzZRmtFgVJhTQs8dptU,11572
+rpa_suite/core/log.py,sha256=cfnThg3cKCRZ4InXPSThKNVuHbN6c06l3wilU0NuDck,17802
+rpa_suite/core/print.py,sha256=tLHIKo6LDTrV91gWKvwlTrxb1idgx3EV_fIRkqtzWBM,6389
+rpa_suite/core/regex.py,sha256=wsTxe8-baKul2Fv1-fycXZ-DVa5krhkc9qMkP04giGs,3303
+rpa_suite/core/validate.py,sha256=0HnCUgT19LPBMhKxIV_hOAoixpqM7TAL9EkC0S56DFc,10976
+rpa_suite/functions/__create_log_dir.py,sha256=-NjH3Mwv8Aa0EgZiD_TcdlSKbsoYl5EoYmPclFwjTKY,3325
+rpa_suite/functions/__create_ss_dir.py,sha256=WMuDDTxM5xWudQjftC7xPr6y3IdiXjVK-GfxkQNIo4c,3377
+rpa_suite/functions/__init__.py,sha256=aa0jejVvnghufR50owKcKpmYit7XVAliyN9gn9JkdLE,33
+rpa_suite/functions/_functions_logger.py,sha256=hlYDEUsmmfwaPlY_YQeNQEFeT_mryHBqgBVyRdxge48,2703
+rpa_suite/functions/_logger.py,sha256=gTYO9JlbX5_jDfu_4FTTajJw3_GotE2BHUbDDB1Hf5g,3643
+rpa_suite/functions/_printer.py,sha256=r72zeobAi2baVbYgbfFH0h5-WMv4tSDGPNlcpZen7O0,3949
+rpa_suite/functions/_variables.py,sha256=vCcktifFUriBQTyUaayZW8BlE8Gr7VP-tFbfomKOS5U,312
+rpa_suite/functions/_variables_uru.py,sha256=xRqYp49l1fFNrHczOmJ6Pqw1PKIWs0f9kxlgvuYGYys,303
+rpa_suite-1.4.2.dist-info/licenses/LICENSE,sha256=5D8PIbs31iGd9i1_MDNg4SzaQnp9sEIULALh2y3WyMI,1102
+rpa_suite-1.4.2.dist-info/METADATA,sha256=Tin3NzbSIPyO5n2MYjC7GExxMDIeyhm6UPi1H9iL0N8,9351
+rpa_suite-1.4.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+rpa_suite-1.4.2.dist-info/top_level.txt,sha256=HYkDtg-kJNAr3F2XAIPyJ-QBbNhk7q6jrqsFt10lz4Y,10
+rpa_suite-1.4.2.dist-info/RECORD,,

rpa_suite-1.4.0.dist-info/RECORD

@@ -1,25 +0,0 @@
-rpa_suite/__init__.py,sha256=a01Ua3RpUt57HOYjAoBdjOhnnGIexnVxDrBmRLWgJvo,71
-rpa_suite/suite.py,sha256=o5xxt4oIJhKFnFeeFnf-Lue19KZlBUcMRA_9Dyc615w,6550
-rpa_suite/core/__init__.py,sha256=VROMsrhKGMqUlstH8cEqp5fwRVC12d3U3_XoxoKOzyg,28
-rpa_suite/core/clock.py,sha256=qGF_fn0_n19WX4GLtzCrwrJmna9HtzfrhLYramOGZm8,12709
-rpa_suite/core/date.py,sha256=dgg-A5GL67MPFP5_0Ie61ymC9pCyDmoVgCJ10zzStrw,5363
-rpa_suite/core/dir.py,sha256=cwwvlPeXFEsoVFdu38Jsfw98t3CbshdS79m5D_y2txQ,7848
-rpa_suite/core/email.py,sha256=yW0x4rDjZZoJ5WDB4C4vWkp25MDfdGSlM9KepBxQV9I,5292
-rpa_suite/core/file.py,sha256=AgXmlyU_AiJ54sKwa8aTWyCjVUfuFhC9-0_m6U6zS7Y,8916
-rpa_suite/core/log.py,sha256=t5TEMHuWMkx9psbbeIyPy3VHs8MJDaSh1h0rdMaYnro,10841
-rpa_suite/core/print.py,sha256=PvEBm7TNNdZFa_qNX67i1JmPVToTBe7I1tQ73B17Onk,5122
-rpa_suite/core/regex.py,sha256=Q2FRI-aUB6oUXunK_0f9sc5kfbZt1qnZb4w7YbzST2o,2602
-rpa_suite/core/validate.py,sha256=J23xB_nXymPKR8eNJb844LJ2OETSPwFT8m2JawbTVz0,9134
-rpa_suite/functions/__create_log_dir.py,sha256=-NjH3Mwv8Aa0EgZiD_TcdlSKbsoYl5EoYmPclFwjTKY,3325
-rpa_suite/functions/__create_ss_dir.py,sha256=WMuDDTxM5xWudQjftC7xPr6y3IdiXjVK-GfxkQNIo4c,3377
-rpa_suite/functions/__init__.py,sha256=aa0jejVvnghufR50owKcKpmYit7XVAliyN9gn9JkdLE,33
-rpa_suite/functions/_functions_logger.py,sha256=hlYDEUsmmfwaPlY_YQeNQEFeT_mryHBqgBVyRdxge48,2703
-rpa_suite/functions/_logger.py,sha256=gTYO9JlbX5_jDfu_4FTTajJw3_GotE2BHUbDDB1Hf5g,3643
-rpa_suite/functions/_printer.py,sha256=r72zeobAi2baVbYgbfFH0h5-WMv4tSDGPNlcpZen7O0,3949
-rpa_suite/functions/_variables.py,sha256=vCcktifFUriBQTyUaayZW8BlE8Gr7VP-tFbfomKOS5U,312
-rpa_suite/functions/_variables_uru.py,sha256=xRqYp49l1fFNrHczOmJ6Pqw1PKIWs0f9kxlgvuYGYys,303
-rpa_suite-1.4.0.dist-info/licenses/LICENSE,sha256=5D8PIbs31iGd9i1_MDNg4SzaQnp9sEIULALh2y3WyMI,1102
-rpa_suite-1.4.0.dist-info/METADATA,sha256=1GclteyzCMHGQ-Hl7TS6yOtvcrOGHH8oEWSRdeaiZdo,9351
-rpa_suite-1.4.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-rpa_suite-1.4.0.dist-info/top_level.txt,sha256=HYkDtg-kJNAr3F2XAIPyJ-QBbNhk7q6jrqsFt10lz4Y,10
-rpa_suite-1.4.0.dist-info/RECORD,,