csc-cia-stne 0.0.33__tar.gz → 0.0.34__tar.gz

{csc_cia_stne-0.0.33 → csc_cia_stne-0.0.34}/PKG-INFO

@@ -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 → csc_cia_stne-0.0.34}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "csc_cia_stne"
-version = "0.0.33"
+version = "0.0.34"
 license = { text = "MIT" }
 description = "Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs"
 keywords = ["karavela", "csc", "cia", "stone", "rpa"]

{csc_cia_stne-0.0.33 → csc_cia_stne-0.0.34}/src/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-0.0.33 → csc_cia_stne-0.0.34}/src/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 → csc_cia_stne-0.0.34}/src/csc_cia_stne.egg-info/PKG-INFO

@@ -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