csc-cia-stne 0.0.33__py3-none-any.whl → 0.0.34__py3-none-any.whl

csc_cia_stne/__init__.py

@@ -13,7 +13,7 @@ from .provio import Provio
 
 # Define os itens disponíveis para importação
 __all__ = [
-    "titulo",
+    "Karavela",
     "BigQuery",
     "BC_Correios",
     "BC_STA",
@@ -25,14 +25,14 @@ __all__ = [
     "Email"
 ]
 
-diretorio_inicial = os.getcwd()
-caminho_env = os.path.join(diretorio_inicial, ".env")
+_diretorio_inicial = os.getcwd()
+_caminho_env = os.path.join(_diretorio_inicial, ".env")
 
 # Carrega .env
-load_dotenv(caminho_env)
+load_dotenv(_caminho_env)
 logger = None  # Inicializa como None
 
-def running_in_container():
+def _running_in_container():
 
     if os.environ.get("KUBERNETES_SERVICE_HOST") or os.path.exists("/.dockerenv"):
         
@@ -60,7 +60,7 @@ def logger():
         
         return get_logger_json()
     
-    elif running_in_container():
+    elif _running_in_container():
         
         return get_logger_json()
     

csc_cia_stne/provio.py

@@ -2,29 +2,63 @@ import logging
 import requests
 from requests.auth import HTTPBasicAuth
 from pydantic import BaseModel, Field, ValidationError
+from typing import List, Dict, Union
 
 # Validadores
 class ProvioModel(BaseModel):
+    """
+    Modelo para validação das credenciais de autenticação.
+    """
     username: str = Field(..., strip_whitespace=True, min_length=1)
     password: str = Field(..., strip_whitespace=True, min_length=1)
 
 class ExportarRelatorioParams(BaseModel):
+    """
+    Modelo para validação dos parâmetros do relatório.
+    """
     ano: int = Field(..., gt=2015, description="O ano deve ser maior que 2015")
     mes: int = Field(..., ge=1, le=12, description="O mês deve estar entre 1 e 12")
 
 # Classe provio
 class Provio:
-    
-    def __init__(self,username:str,password:str):
-        
+    """
+    Classe para interagir com a API do Provio.
+    """
+
+    def __init__(self, username: str, password: str):
+        """
+        Inicializa a classe com as credenciais de autenticação.
+
+        Args:
+            username (str): Nome de usuário para autenticação.
+            password (str): Senha para autenticação.
+
+        Raises:
+            ValidationError: Se as credenciais forem inválidas de acordo com o modelo `ProvioModel`.
+        """        
         # Validação usando Pydantic
         data = ProvioModel(username=username, password=password)
 
         self.api_url = "https://provio.apps.stone.com.br/api/reports"
         self.auth = HTTPBasicAuth(data.username, data.password)
 
-    def exportar_relatorio_geral(self, ano:int, mes:int):
-        
+    def exportar_relatorio_geral(self, ano: int, mes: int) -> Dict[str, Union[bool, str, List[Dict]]]:
+        """
+        Exporta o relatório geral para o período especificado.
+
+        Args:
+            ano (int): Ano do relatório (deve ser maior que 2015).
+            mes (int): Mês do relatório (deve estar entre 1 e 12).
+
+        Returns:
+            Dict[str, Union[bool, str, List[Dict]]]: Um dicionário contendo:
+                - `success` (bool): Indica se a exportação foi bem-sucedida.
+                - `error` (str): Mensagem de erro, se houver.
+                - `report` (List[Dict]): Lista de registros exportados, se `success` for `True`.
+
+        Raises:
+            ValidationError: Se os parâmetros `ano` e `mes` forem inválidos.
+        """        
         # Validação dos parâmetros
         params = ExportarRelatorioParams(ano=ano, mes=mes)
         periodo = f"{params.ano}-{params.mes:02d}"

{csc_cia_stne-0.0.33.dist-info → csc_cia_stne-0.0.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: csc_cia_stne
-Version: 0.0.33
+Version: 0.0.34
 Summary: Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs
 License: MIT
 Keywords: karavela,csc,cia,stone,rpa

{csc_cia_stne-0.0.33.dist-info → csc_cia_stne-0.0.34.dist-info}/RECORD

@@ -1,4 +1,4 @@
-csc_cia_stne/__init__.py,sha256=PlHybccf5ZcwFE56zRvXFKB-z7Hv0l1rp1AXuA4AlnU,1529
+csc_cia_stne/__init__.py,sha256=dR9aDvx5m3ddFuoOQfboKrE4v-MeqZuzfe0PuSIIqHY,1537
 csc_cia_stne/bc_correios.py,sha256=ANsvLyL7wdkM0MvjjBHB2Ih4eyTcyWgt5IqiK0Rv89E,23014
 csc_cia_stne/bc_sta.py,sha256=uyoCp-KTpkWwpyWNWp20JuDfMRYGCKxERnRQVso80iQ,10903
 csc_cia_stne/email.py,sha256=dGgn-0_EM2-AUyz2genrokINHCaqYqAh4QC3xhl4deA,4160
@@ -7,7 +7,7 @@ csc_cia_stne/google_drive.py,sha256=3kGd4swPr6fLUJnQplq4VzAgF8X0Ho0Ke4JJN4RE-_8,
 csc_cia_stne/karavela.py,sha256=Q7MbQXXz_jtrLHM7QeenbSzcro07EpoFk4lKglivJ_I,3564
 csc_cia_stne/logger_json.py,sha256=W6Fj0G1-TWXHdHoLLX5SbVV7BSpVvjHm1fkKI5Q69YQ,3129
 csc_cia_stne/logger_rich.py,sha256=4KVwxz87AA52qEMpgCh1SlS--7a57LK4Y4HSnKmRruc,7514
-csc_cia_stne/provio.py,sha256=TF6_1uygkzftkhsOn6eMGkNqIWliKwcvh54RM10WzRo,2383
+csc_cia_stne/provio.py,sha256=-HU1wcCX9fHSiaxSDKeTj5VXfATcnMeZJJ-nBLmNyfY,3696
 csc_cia_stne/servicenow.py,sha256=QN7R49Bb8HcqfGT9iytbPaqwV2rtH4N7Nhvb_kfTsHU,36400
 csc_cia_stne/stne_admin.py,sha256=G5ozXt18VjKL2BHtROQk4GnfVY1xM14RXSQ-rra_D54,15487
 csc_cia_stne/utilitarios/__init__.py,sha256=4YFhzxu8F_CDHU6iaNhpzz9mfX-8wfJc1XEQInJzwJ4,98
@@ -20,8 +20,8 @@ csc_cia_stne/utilitarios/validations/GcpBigQueryValidator.py,sha256=BSJ84FBuOxbh
 csc_cia_stne/utilitarios/validations/GoogleDriveValidator.py,sha256=OaT6F98RyP3iIMsIQMc0CCDUt0u7EkKxG_UoHm2ME3c,1376
 csc_cia_stne/utilitarios/validations/ServiceNowValidator.py,sha256=9IS3ucuLXeeebfVpvywEu9OiN-BfbXTuowTBEotUbow,5991
 csc_cia_stne/utilitarios/validations/__init__.py,sha256=VE49g8ExrBUyyUzhOUjsP9880L1PWCKPHckd848MQeo,71
-csc_cia_stne-0.0.33.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
-csc_cia_stne-0.0.33.dist-info/METADATA,sha256=_H_zaP8InDgMCsvQHlafwnLTrBxfwA3-OHmdF9e4Zts,1003
-csc_cia_stne-0.0.33.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-csc_cia_stne-0.0.33.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
-csc_cia_stne-0.0.33.dist-info/RECORD,,
+csc_cia_stne-0.0.34.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
+csc_cia_stne-0.0.34.dist-info/METADATA,sha256=ay89ISVMxA2mN0a_KPgnm9lhfOuR5s_KMUkCi45fK6c,1003
+csc_cia_stne-0.0.34.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+csc_cia_stne-0.0.34.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
+csc_cia_stne-0.0.34.dist-info/RECORD,,