rpa-suite 1.3.7__tar.gz → 1.4.1__tar.gz

{rpa_suite-1.3.7 → rpa_suite-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rpa_suite
-Version: 1.3.7
+Version: 1.4.1
 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
@@ -24,6 +24,7 @@ Requires-Dist: email_validator
 Requires-Dist: loguru
 Requires-Dist: typing
 Requires-Dist: pillow
+Requires-Dist: pyautogui
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -185,7 +186,7 @@ Lançamento: *20/02/2024*
 
 Status: Em desenvolvimento.
 
-### Notas da atualização: 1.3.7
+### Notas da atualização: 1.4.1
 
 - 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.3.7 → rpa_suite-1.4.1}/README.md

@@ -148,7 +148,7 @@ Lançamento: *20/02/2024*
 
 Status: Em desenvolvimento.
 
-### Notas da atualização: 1.3.7
+### Notas da atualização: 1.4.1
 
 - 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.1/rpa_suite/__init__.py

@@ -0,0 +1,59 @@
+# 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
+
+    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-1.3.7 → rpa_suite-1.4.1}/rpa_suite/core/clock.py

@@ -7,7 +7,37 @@ 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):
         ...
     

{rpa_suite-1.3.7 → rpa_suite-1.4.1}/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-1.3.7 → rpa_suite-1.4.1}/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-1.4.1/rpa_suite/core/email.py

@@ -0,0 +1,190 @@
+# /sender_smtp.py
+
+import smtplib, os
+from email.mime.image import MIMEImage
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.mime.base import MIMEBase
+from email import encoders
+from rpa_suite.functions._printer import alert_print, error_print, success_print
+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",
+    email_password:str = "password",
+    email_to: str = "to@email.com",
+    attachments: list[str] = [],
+    subject_title: str = 'Test title',
+    body_message: str = '<p>Testing message body</p>'
+    auth_tls: bool = False,
+
+
+    def __init__(self):
+        ...
+
+    def send_smtp(
+        self,
+        email_user:str,
+        email_password:str,
+        email_to: str,
+        subject_title: str = 'Test title',
+        body_message: str = '<p>Testing message body</p>',
+        attachments: list[str] = [],
+        smtp_server:str = "smtp.hostinger.com",
+        smtp_port:str = 465,
+        auth_tls: bool = False,
+        display_message: bool = True,
+        ):
+
+        """
+        Envia um e-mail utilizando o servidor SMTP especificado.
+
+        Args:
+            smtp_server (str, optional): Endereço do servidor SMTP. 
+                Padrão: "smtp.hostinger.com".
+            smtp_port (str, optional): 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. 
+                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. 
+                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.
+        """
+
+        try:
+            self.smtp_server = smtp_server
+            self.smtp_port = smtp_port
+            self.email_user = email_user
+            self.email_password = email_password
+            self.email_to = email_to
+            self.subject_title = subject_title
+            self.body_message = body_message
+            self.attachments = attachments
+            self.auth_tls = auth_tls
+
+            # Criando a mensagem
+            msg = MIMEMultipart()
+            msg['From'] = self.email_user
+            msg['To'] = ', '.join(self.email_to) if isinstance(self.email_to, list) else self.email_to
+            msg['Subject'] = str(self.subject_title)
+
+            # Corpo do e-mail
+            body = str(self.body_message)
+            msg.attach(MIMEText(body, 'html'))
+
+            # Anexos (opcional)
+            if self.attachments:
+                from email.mime.base import MIMEBase
+                from email import encoders
+                import os
+
+                for attachment_path in self.attachments:
+                    try:
+                        with open(attachment_path, "rb") as attachment:
+                            part = MIMEBase("application", "octet-stream")
+                            part.set_payload(attachment.read())
+                            encoders.encode_base64(part)
+                            part.add_header(
+                                "Content-Disposition",
+                                f"attachment; filename= {os.path.basename(attachment_path)}",
+                            )
+                            msg.attach(part)
+
+                    except Exception as e:
+                        error_print(f"Erro ao anexar o arquivo {attachment_path}: {str(e)}")
+
+            try:
+                if self.auth_tls:
+                    # Conectando ao servidor SMTP com TLS
+                    server = smtplib.SMTP(self.smtp_server, self.smtp_port)
+                    server.starttls()
+                    server.login(self.email_user, self.email_password)
+                else:
+                    # Conectando ao servidor SMTP com SSL
+                    server = smtplib.SMTP_SSL(self.smtp_server, self.smtp_port)
+                    server.login(self.email_user, self.email_password)
+
+                # Enviando o e-mail
+                server.sendmail(self.email_user, self.email_to, msg.as_string())
+                if display_message: success_print("E-mail enviado com sucesso!")
+
+                # Encerrando a conexão
+                server.quit()
+
+            except Exception as e:
+                alert_print(f"Falha ao enviar o e-mail: {str(e)}")
+
+        except Exception as e:
+            error_print(f"Ocorreu um erro geral na função sendmail: {str(e)}")

{rpa_suite-1.3.7 → rpa_suite-1.4.1}/rpa_suite/core/file.py

@@ -6,7 +6,55 @@ from colorama import Fore
 from typing import Dict, List, Union
 
 class File():
-    
+    """
+    Class that provides utilities for file management, including creating, deleting, and manipulating files.
+
+    This class offers functionalities for:
+        - Creating files
+        - Deleting files
+        - Reading and writing file content
+        - File path management
+
+    Methods:
+        create_file: Creates a new file with specified content
+        delete_file: Deletes a specified file
+        read_file: Reads content from a specified file
+        write_file: Writes content to a specified file
+
+    The File class is part of RPA Suite and can be accessed through the rpa object:
+        >>> from rpa_suite import rpa
+        >>> rpa.file.create_file('example.txt', 'Hello, World!')
+
+    Parameters:
+        file_name (str): The name of the file to be created or manipulated
+        content (str): The content to be written to the file
+        path (str): The directory path where the file should be created or deleted
+
+    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 arquivos
+        - Excluir arquivos
+        - Ler e escrever conteúdo de arquivos
+        - Gerenciamento de caminhos de arquivos
+
+    Métodos:
+        create_file: Cria um novo arquivo com o conteúdo especificado
+        delete_file: Exclui um arquivo especificado
+        read_file: Lê o conteúdo de um arquivo especificado
+        write_file: Escreve conteúdo em um arquivo especificado
+
+    A classe File é parte do RPA Suite e pode ser acessada através do objeto rpa:
+        >>> from rpa_suite import rpa
+        >>> rpa.file.create_file('exemplo.txt', 'Olá, Mundo!')
+
+    Parâmetros:
+        file_name (str): O nome do arquivo a ser criado ou manipulado
+        content (str): O conteúdo a ser escrito no arquivo
+        path (str): O caminho do diretório onde o arquivo deve ser criado ou excluído
+    """
     def __init__(self):
         self.__create_ss_dir = create_ss_dir