rpa-suite 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

rpa_suite/file/screen_shot.py

@@ -0,0 +1,82 @@
+# /screen_shot.py
+
+import os, time
+from datetime import datetime
+from rpa_suite import suite as rpa
+
+
+try:
+    import pyautogui
+    import pyscreeze
+    
+except ImportError:
+    raise ImportError(" The ‘pyautogui’, ‘Pillow’, and ‘PyScreeze’ libraries are necessary to use this module. Please install them with ‘pip install pyautogui pillow pyscreeze’.")
+
+
+def screen_shot(file_path: str, file_name: str = 'screenshot', save_with_date: bool = True, delay: int = 1) -> str | None:
+
+    """
+    Function responsible for create a dir for screenshot, and file screenshot and save this in dir to create, if dir exists save it on original dir. By default uses date on file name. \n
+
+    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`.
+    ``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).
+
+    Return:
+    ----------
+    >>> type:str
+        * 'screenshot_path': str - represents the absulute path created for this file
+
+    Description: pt-br
+    ----------
+    Função responsável por criar um diretório para captura de tela, e arquivo de captura de tela e salvar isso no diretório a ser criado, se o diretório existir, salve-o no diretório original. Por padrão, usa a data no nome do arquivo.
+
+    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`.
+    ``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).
+    
+    Retorno:
+    ----------
+    >>> tipo: str
+        * 'screenshot_path': str - representa o caminho absoluto do arquivo criado
+    """
+
+    # proccess
+    try:
+        
+        time.sleep(delay)
+        if not os.path.exists(file_path):
+
+            # if dir not exists create it
+            try:
+                os.makedirs(file_path)
+                rpa.success_print(f"Diretório criado com sucesso em: '{file_path}'!")
+
+            except OSError as e:
+                rpa.error_print(f"Falha ao criar o diretório em: '{file_path}'! Error: {str(e)}")
+
+        
+        if save_with_date: # use date on file name
+            image = pyautogui.screenshot()
+            path_file_screenshoted =  fr'{file_path}/{file_name}_{datetime.today().strftime("%d_%m_%Y-%H_%M_%S")}.png'
+
+            image.save(path_file_screenshoted)
+            return os.path.abspath(path_file_screenshoted)
+        
+        else: # not use date on file name
+            image = pyautogui.screenshot()
+            path_file_screenshoted =  fr'{file_path}/{file_name}.png'
+
+            image.save(path_file_screenshoted)
+            return os.path.abspath(path_file_screenshoted)
+    
+    except Exception as e:
+
+        rpa.error_print(f'Erro durante a função {screen_shot.__name__}! Error: {str(e)}')
+        return None

{rpa_suite-1.0.2.dist-info → rpa_suite-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rpa-suite
-Version: 1.0.2
+Version: 1.0.3
 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
@@ -127,6 +127,9 @@ No setup do nosso projeto já estão inclusas as dependências, só será necess
 - loguru
 - email-validator
 - colorlog
+
+[!IMPORTANT]
+No caso da função de screenshot é necessario ter as libs 'pyautogui' 'pillow' e 'pyscreeze' instalados, geralmente a instalação de pyautogui já instala as demais dependencias deste caso.
   
 ## Estrutura do módulo
 O módulo principal do rpa-suite é dividido em categorias. Cada categoria contém módulos com funções destinadas a cada tipo de tarefa
@@ -141,6 +144,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
     - **file**
         - **counter** - Funções para contagem de arquivos
         - **temp_dir** - Funções para diretórios temporários
+        -**screen_shot** -  Função para criar diretório e arquivo de print com nome do diretório, arquivo e delay personalizáveis.
     - **log**
         - **logger_uru** - Instanciador de stream e handlefile que cria na pasta raiz do arquivo chamador pasta de log e seta o stream para as funções de log
         - **functions_logger_uru** - Funções de log parecida com os prints personalizados, setadas e personalizadas para todos log levels usado pelo ´logger_uru´, já escreve no arquivo setado além de gerar o print no terminal
@@ -152,7 +156,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
         - **string_validator** - Função que valida presença de letras, palavras, e texto em strings
 
 ## Release
-Versão: **Beta 1.0.2**
+Versão: **Beta 1.0.3**
 
 Lançamento: *20/02/2024*
 

{rpa_suite-1.0.2.dist-info → rpa_suite-1.0.3.dist-info}/RECORD

@@ -10,6 +10,7 @@ rpa_suite/email/__init__.py,sha256=haPk94yjX88kR5YpzNNFCpzHw0T7fKAEoiaHA3-vAds,1
 rpa_suite/email/sender_smtp.py,sha256=e6DgITLLB1Acx1yQbHBargHT3UGxLDpTdHkQ0w8EgaM,7598
 rpa_suite/file/__init__.py,sha256=haPk94yjX88kR5YpzNNFCpzHw0T7fKAEoiaHA3-vAds,14
 rpa_suite/file/counter.py,sha256=vFaqENBC6HLv7dHmEmibsHhLVfumTM6Dh7p-u2g6s5Y,2483
+rpa_suite/file/screen_shot.py,sha256=3SFKSS1Kb9UlKY3Lt6cE9Bym7i44iu7XeMqzZ2d4dhc,3282
 rpa_suite/file/temp_dir.py,sha256=NnoLbpgCm9ZoC2D2mzywo756d8BBt_1fhQeNUUnxsPs,7134
 rpa_suite/log/__create_log_dir.py,sha256=Lm3qbIhJ0z4zBkRIdR5AFw8voBRaAGuEwr8G-6cSPGg,3318
 rpa_suite/log/__init__.py,sha256=haPk94yjX88kR5YpzNNFCpzHw0T7fKAEoiaHA3-vAds,14
@@ -26,8 +27,8 @@ rpa_suite/regex/list_from_text.py,sha256=HJaV_nhjCjn8UkJgEsnnKO2hYuE-zVDCAH9MD6X
 rpa_suite/validate/__init__.py,sha256=haPk94yjX88kR5YpzNNFCpzHw0T7fKAEoiaHA3-vAds,14
 rpa_suite/validate/mail_validator.py,sha256=dtFdthDd3gHyJ0uEUT9yPFFP1yyq4TXLxKLV1gqcNMo,2930
 rpa_suite/validate/string_validator.py,sha256=8dGAHhvZu19yIVOoX-te1pVqVi7cwDrFJKf107cLgvA,5370
-rpa_suite-1.0.2.dist-info/LICENSE,sha256=5D8PIbs31iGd9i1_MDNg4SzaQnp9sEIULALh2y3WyMI,1102
-rpa_suite-1.0.2.dist-info/METADATA,sha256=T19oR6oPJK7UjXuNo1UnpjXMZGJYTfukG-5yiEG0AlU,7382
-rpa_suite-1.0.2.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-rpa_suite-1.0.2.dist-info/top_level.txt,sha256=HYkDtg-kJNAr3F2XAIPyJ-QBbNhk7q6jrqsFt10lz4Y,10
-rpa_suite-1.0.2.dist-info/RECORD,,
+rpa_suite-1.0.3.dist-info/LICENSE,sha256=5D8PIbs31iGd9i1_MDNg4SzaQnp9sEIULALh2y3WyMI,1102
+rpa_suite-1.0.3.dist-info/METADATA,sha256=CpzZ1QqgR998I_tGfzPZSGwMUjJkMK1GLNRG0cuRC7k,7729
+rpa_suite-1.0.3.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+rpa_suite-1.0.3.dist-info/top_level.txt,sha256=HYkDtg-kJNAr3F2XAIPyJ-QBbNhk7q6jrqsFt10lz4Y,10
+rpa_suite-1.0.3.dist-info/RECORD,,