rpa-suite 1.1.3__tar.gz → 1.1.5__tar.gz

{rpa_suite-1.1.3 → rpa_suite-1.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rpa_suite
-Version: 1.1.3
+Version: 1.1.5
 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
@@ -156,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.1.3**
+Versão: **Beta 1.1.5**
 
 Lançamento: *20/02/2024*
 

{rpa_suite-1.1.3 → rpa_suite-1.1.5}/README.md

@@ -131,7 +131,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.1.3**
+Versão: **Beta 1.1.5**
 
 Lançamento: *20/02/2024*
 

rpa_suite-1.1.5/rpa_suite/file/__create_ss_dir.py

@@ -0,0 +1,83 @@
+# /_create_ss_dir.py
+
+import os
+from typing import Union
+from rpa_suite.log.printer import error_print, alert_print, success_print
+
+
+def __create_ss_dir(path_to_create: str = 'default', name_ss_dir: str='screenshots') -> dict[str, Union[bool, str, None]]:
+
+    """
+    Function responsible for creating a screenshots directory to work with your screenshot files. \n
+
+    Parameters:
+    ----------
+    ``path_to_create: str`` - should be a string with the full path pointing to the folder where the screenshots folder should be created, if it is empty the ``default`` value will be used which will create a folder in the current directory where the file containing this function was called.
+
+    ``name_ss_dir: str`` - should be a string representing the name of the logger directory to be created. If it is empty, the ``temp`` value will be used as the default directory name.
+
+    Return:
+    ----------
+    >>> type:dict
+        * 'success': bool - represents case the action was performed successfully
+        * 'path_created': str - path of the directory that was created on the process
+        
+    Description: pt-br
+    ----------
+    Função responsavel por criar diretório de screenshots para trabalhar com seus arquivos de sreenshot. \n
+
+    Parametros:
+    ----------
+    ``path_to_create: str`` - deve ser uma string com o path completo apontando para a pasta onde deve ser criada a pasta temporaria, se estiver vazio sera usado valor ``default`` que criará pasta no diretório atual onde o arquivo contendo esta função foi chamada.
+
+    ``name_ss_dir: str`` - deve ser uma string representando o nome do diretório de screenshots a ser criado. Se estiver vazio, o valor ``screenshots`` será usado como o nome padrão do diretório.
+
+    Retorno:
+    ----------
+    >>> type:dict
+        * 'success': bool - representa se ação foi realizada com sucesso
+        * 'path_created': str - path do diretório que foi criado no processo
+    """
+    
+    # Local Variables
+    result: dict = {
+        'success': bool,
+        'path_created': str,
+    }
+    
+    try:
+        # by 'default', defines path to local script execution path
+        if path_to_create == 'default':
+            path_to_create: str = os.getcwd()
+
+        # Build path to new dir
+        full_path: str = os.path.join(path_to_create, name_ss_dir)
+
+        # Create dir in this block
+        try:
+
+            # Successefully created
+            os.makedirs(full_path, exist_ok=False)
+
+            result['success'] = True
+            result['path_created'] = fr'{full_path}'
+
+            success_print(f"Diretório:'{full_path}' foi criado com sucesso.")
+
+        except FileExistsError:
+            result['success'] = False
+            result['path_created'] = full_path
+            # alert_print(f"Diretório:'{full_path}' já existe.")
+
+        except PermissionError:
+            result['success'] = False
+            result['path_created'] = None
+            alert_print(f"Permissão negada: não é possível criar o diretório '{full_path}'.")
+
+    except Exception as e:
+        result['success'] = False
+        result['path_created'] = None
+        error_print(f'Error capturing current path to create screenshots directory! Error: {str(e)}')
+        
+    finally:
+        return result

{rpa_suite-1.1.3 → rpa_suite-1.1.5}/rpa_suite/file/screen_shot.py

@@ -2,18 +2,13 @@
 
 import os, time
 from datetime import datetime
-from rpa_suite.log.printer import error_print
+from rpa_suite.log.printer import error_print, success_print
+from .__create_ss_dir import __create_ss_dir
 
 
-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:
+def screen_shot(path_dir:str = None, file_name: str = 'screenshot', save_with_date: bool = True, delay: int = 1, use_default_path_and_name: bool = True, name_ss_dir:str = None) -> 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
@@ -50,30 +45,41 @@ def screen_shot(file_path: str, file_name: str = 'screenshot', save_with_date: b
     # proccess
     try:
         
+        try:
+            import pyautogui
+            import pyscreeze
+            
+        except ImportError:
+            raise ImportError(" The ‘pyautogui’ e ‘Pillow’ libraries are necessary to use this module. Please install them with ‘pip install pyautogui pillow.")
+        
         time.sleep(delay)
-        if not os.path.exists(file_path):
-
-            # if dir not exists create it
-            try:
-                os.makedirs(file_path)
 
-            except OSError as e:
-                error_print(f"Falha ao criar o diretório em: '{file_path}'! Error: {str(e)}")
+        if not use_default_path_and_name:
+            result_tryed: dict = __create_ss_dir(path_dir, name_ss_dir)
+            path_dir = result_tryed['path_created']
+        else:
+            if path_dir == None and name_ss_dir == None:
+                result_tryed: dict = __create_ss_dir()
+                path_dir = result_tryed['path_created']
 
         
         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'
-
+            file_name = f'{file_name}_{datetime.today().strftime("%d_%m_%Y-%H_%M_%S")}.png'
+            path_file_screenshoted = os.path.join(path_dir, file_name)
+            
+            success_print(path_file_screenshoted)
+            
             image.save(path_file_screenshoted)
-            return os.path.abspath(path_file_screenshoted)
+            return path_file_screenshoted
         
         else: # not use date on file name
             image = pyautogui.screenshot()
-            path_file_screenshoted =  fr'{file_path}/{file_name}.png'
-
+            file_name = f'{file_name}.png'
+            path_file_screenshoted = os.path.join(path_dir, file_name)
+            
             image.save(path_file_screenshoted)
-            return os.path.abspath(path_file_screenshoted)
+            return path_file_screenshoted
     
     except Exception as e:
 

{rpa_suite-1.1.3 → rpa_suite-1.1.5}/rpa_suite/suite.py

@@ -12,7 +12,7 @@ Here is an overview of the available submodules:
 - **CLOCK**: Functions related to time, such as waiting for an execution or executing at a specific hour.
 - **DATE**: Functions for working with dates.
 - **EMAIL**: Functions for sending emails.
-- **FILE**: Functions for working with files, such as counting files or creating temporary directories.
+- **FILE**: Functions for working with files, such as counting files or creating temporary directories and screenshot too.
 - **LOG**: Functions for logging events and printing messages.
 - **REGEX**: Functions for working with regular expressions.
 - **VALIDATE**: Functions for validating inputs, such as emails or strings.
@@ -43,7 +43,7 @@ from .email.sender_smtp import send_email
 """MODULE FILE"""
 from .file.counter import count_files
 from .file.temp_dir import create_temp_dir, delete_temp_dir
-
+from .file.screen_shot import screen_shot
 
 """MODULE LOG"""
 # from .log.loggin import logging_decorator
@@ -104,6 +104,7 @@ class Rpa_suite():
     count_files = count_files
     create_temp_dir = create_temp_dir
     delete_temp_dir = delete_temp_dir
+    screen_shot = screen_shot
     #clear_temp_dir = clear_temp_dir
 
     # log - printer
@@ -134,7 +135,6 @@ class Rpa_suite():
 
 # Create a instance of Rpa_suite
 
-
 # Define function to return this instance
 def invoke() -> Rpa_suite:
 

{rpa_suite-1.1.3 → rpa_suite-1.1.5}/rpa_suite.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rpa-suite
-Version: 1.1.3
+Version: 1.1.5
 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
@@ -156,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.1.3**
+Versão: **Beta 1.1.5**
 
 Lançamento: *20/02/2024*
 

{rpa_suite-1.1.3 → rpa_suite-1.1.5}/rpa_suite.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ rpa_suite/date/__init__.py
 rpa_suite/date/date.py
 rpa_suite/email/__init__.py
 rpa_suite/email/sender_smtp.py
+rpa_suite/file/__create_ss_dir.py
 rpa_suite/file/__init__.py
 rpa_suite/file/counter.py
 rpa_suite/file/screen_shot.py

{rpa_suite-1.1.3 → rpa_suite-1.1.5}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='rpa_suite',
-    version='1.1.3',
+    version='1.1.5',
     packages=find_packages(),
     description='Conjunto de ferramentas essenciais para Automação RPA com Python, que facilitam o dia a dia de desenvolvimento.',
     long_description_content_type='text/markdown',