luxorasap 0.0.2__tar.gz → 0.1.1__tar.gz

{luxorasap-0.0.2 → luxorasap-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luxorasap
-Version: 0.0.2
+Version: 0.1.1
 Summary: Luxor’s unified toolbox for data ingestion, querying and analytics.
 Author-email: Luxor Group <backoffice@luxor.com.br>
 License: Proprietary – All rights reserved
@@ -18,15 +18,25 @@ Requires-Dist: pyarrow>=15.0
 Requires-Dist: requests>=2.32
 Requires-Dist: pydantic>=2.7
 Requires-Dist: scipy>=1.13
+Requires-Dist: openpyxl
+Provides-Extra: storage
+Requires-Dist: azure-storage-blob>=12.19; extra == "storage"
+Requires-Dist: pyarrow>=15.0; extra == "storage"
+Provides-Extra: dataframe
+Requires-Dist: pandas>=2.2; extra == "dataframe"
 Provides-Extra: datareader
-Requires-Dist: pyarrow>=15.0; extra == "datareader"
+Requires-Dist: luxorasap[dataframe,storage]; extra == "datareader"
+Requires-Dist: numpy>=1.25; extra == "datareader"
+Requires-Dist: scipy>=1.13; extra == "datareader"
 Provides-Extra: ingest
-Requires-Dist: pandera>=0.18; extra == "ingest"
+Requires-Dist: luxorasap[dataframe,storage]; extra == "ingest"
+Requires-Dist: pandas>=2.2; extra == "ingest"
 Provides-Extra: btgapi
 Requires-Dist: requests>=2.32; extra == "btgapi"
 Requires-Dist: pydantic>=2.7; extra == "btgapi"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: requests-mock>=1.11; extra == "dev"
 Requires-Dist: black>=24.4.0; extra == "dev"
 Requires-Dist: isort>=5.13; extra == "dev"
 Requires-Dist: bumpver>=2024.3; extra == "dev"

{luxorasap-0.0.2 → luxorasap-0.1.1}/pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta"
 #############################
 [project]
 name            = "luxorasap"
-version = "0.0.2"
+version = "0.1.1"
 description     = "Luxor’s unified toolbox for data ingestion, querying and analytics."
 readme          = "README.md"
 requires-python = ">=3.9"
@@ -36,15 +36,19 @@ dependencies = [
   "requests>=2.32",     # usado por btgapi
   "pydantic>=2.7",      # usado por btgapi
   "scipy>=1.13",
+  "openpyxl"
 ]
 
 [project.optional-dependencies]
 # mantém para uso futuro ou para quem queira instalação granular
-datareader = ["pyarrow>=15.0"]
-ingest     = ["pandera>=0.18"]
+storage   = ["azure-storage-blob>=12.19", "pyarrow>=15.0"]
+dataframe = ["pandas>=2.2"]
+datareader = ["luxorasap[storage,dataframe]", "numpy>=1.25", "scipy>=1.13"]
+ingest     = ["luxorasap[storage,dataframe]", "pandas>=2.2"]
 btgapi     = ["requests>=2.32", "pydantic>=2.7"]
 dev        = [
   "pytest>=8.2",
+  "requests-mock>=1.11",
   "black>=24.4.0",
   "isort>=5.13",
   "bumpver>=2024.3",
@@ -70,7 +74,7 @@ exclude = ["tests*"]
 # bumpver (sem-ver)
 #############################
 [tool.bumpver]
-current_version = "0.0.2"
+current_version = "0.1.1"
 version_pattern = "MAJOR.MINOR.PATCH"
 
 # regex explícito – obrigatório no bumpver 2024+

{luxorasap-0.0.2 → luxorasap-0.1.1}/src/luxorasap/__init__.py

@@ -13,7 +13,7 @@ from types import ModuleType
 try:
     __version__: str = metadata.version(__name__)
 except metadata.PackageNotFoundError:  # editable install
-    __version__ = "0.0.2"
+    __version__ = "0.1.1"
 
 # ─── Lazy loader ─────────────────────────────────────────────────
 def __getattr__(name: str) -> ModuleType:

luxorasap-0.1.1/src/luxorasap/btgapi/__init__.py

@@ -0,0 +1,16 @@
+"""Wrapper para as APIs do BTG Pactual."""
+
+from .auth import get_access_token, BTGApiError
+from .reports import request_portfolio, await_report_ticket_result, process_zip_to_dfs, request_investors_transactions_report
+from .trades import submit_offshore_equity_trades, await_transaction_ticket_result
+
+__all__ = [
+    "BTGApiError",
+    "get_access_token",
+    "request_portfolio",
+    "await_report_ticket_result",
+    "submit_offshore_equity_trades",
+    "await_transaction_ticket_result",
+    "process_zip_to_dfs",
+    "request_investors_transactions_report"
+]

luxorasap-0.1.1/src/luxorasap/btgapi/auth.py

@@ -0,0 +1,57 @@
+import os
+import requests
+from dotenv import load_dotenv
+from loguru import logger
+
+__all__ = ["BTGApiError", "get_access_token"]
+
+
+class BTGApiError(Exception):
+    """Erro genérico da API do BTG."""
+
+
+def get_access_token(*, client_id=None, client_secret=None, test_env: bool = True,
+                    timeout: int = 20) -> str:
+    """Obtém JWT válido por ~1 h para autenticação nas APIs BTG.
+    Args:
+        client_id: ID do cliente (opcional, lê de env var se None).
+        client_secret: Segredo do cliente (opcional, lê de env var se None).
+        test_env: Ambiente de teste (True) ou produção (False).
+        timeout: Timeout da requisição em segundos.
+
+    Returns:
+        Token de acesso.
+
+    Raises:
+        BTGApiError: Se as credenciais não estiverem disponíveis ou a requisição falhar.
+    """
+
+    if not client_id or not client_secret:
+        load_dotenv()
+        client_id = os.getenv("BTG_CLIENT_ID")
+        client_secret = os.getenv("BTG_CLIENT_SECRET")
+    if not client_id or not client_secret:
+        raise BTGApiError("BTG_CLIENT_ID ou BTG_CLIENT_SECRET não definidos no ambiente")
+
+    url = (
+        "https://funds-uat.btgpactual.com/connect/token"
+        if test_env
+        else "https://funds.btgpactual.com/connect/token"
+    )
+
+    resp = requests.post(
+        url,
+        headers={"Content-Type": "application/x-www-form-urlencoded"},
+        data={
+            "grant_type": "client_credentials",
+            "client_id": client_id,
+            "client_secret": client_secret,
+        },
+        timeout=timeout,
+    )
+
+    if resp.ok:
+        token = resp.json().get("access_token")
+        logger.debug("Token BTG obtido (len=%s)", len(token) if token else "None")
+        return token or ""
+    raise BTGApiError(f"Falha ao autenticar: HTTP {resp.status_code} – {resp.text}")

luxorasap-0.1.1/src/luxorasap/btgapi/reports.py

@@ -0,0 +1,188 @@
+import datetime as dt
+import io
+import json
+import time
+import zipfile
+from typing import Optional, Dict
+import pandas as pd
+import requests
+from loguru import logger
+
+from .auth import BTGApiError
+from luxorasap.utils.dataframe import read_bytes
+
+__all__ = [
+    "request_portfolio",
+    "check_report_ticket",
+    "await_report_ticket_result",
+    "process_zip_to_dfs",
+    "request_investors_transactions_report"
+]
+
+_REPORT_ENDPOINT = "https://funds.btgpactual.com/reports/Portfolio"
+_TICKET_ENDPOINT = "https://funds.btgpactual.com/reports/Ticket"
+_INVESTOR_TX_ENDPOINT = (
+    "https://funds.btgpactual.com/reports/RTA/InvestorTransactionsFileReport"
+)
+_REPORT_TYPES = {"excel": 10, "xml5": 81, "pdf": 2}
+
+
+def request_portfolio(token: str, fund_name: str, start_date: dt.date, end_date: dt.date,
+                      format: str = "excel") -> str:
+    """Envia requisição de carteira; retorna *ticket*.
+    
+    Args:
+        token: Token de autenticação.
+        fund_name: Nome do fundo.
+        start_date: Data de início.
+        end_date: Data de fim.
+        format: Formato do relatório ("excel", "xml5", "pdf").
+    
+    Returns:
+        Ticket da requisição.
+    """
+    body = {
+        "contract": {
+            "startDate": f"{start_date}T00:00:00Z",
+            "endDate": f"{end_date}T00:00:00Z",
+            "typeReport": _REPORT_TYPES[format],
+            "fundName": fund_name,
+        },
+        "pageSize": 100,
+        "webhookEndpoint": "string",
+    }
+    r = requests.post(
+        _REPORT_ENDPOINT,
+        headers={"X-SecureConnect-Token": token, "Content-Type": "application/json"},
+        json=body,
+        timeout=30,
+    )
+    if r.ok:
+        return r.json()["ticket"]
+    raise BTGApiError(f"Erro ao solicitar relatório: {r.status_code} – {r.text}")
+
+
+def _download_url(download_url: str) -> bytes:
+    r = requests.get(download_url, timeout=60)
+    if r.ok:
+        return r.content
+    raise BTGApiError(f"Falha no download: {r.status_code} – {r.text}")
+
+
+def check_report_ticket(token: str, ticket: str, *, page: Optional[int] = None) -> bytes:
+    """Consulta único ticket; devolve bytes se pronto, lança BTGApiError caso contrário."""
+
+    params = {"ticketId": ticket}
+    if page is not None:
+        params["pageNumber"] = str(page)
+
+    r = requests.get(
+        _TICKET_ENDPOINT,
+        params=params,
+        headers={"X-SecureConnect-Token": token},
+        timeout=30,
+    )
+    # 1. Se resposta é ZIP direto → retornamos conteúdo
+    try:
+        payload = r.json()
+    except json.JSONDecodeError:
+        if r.ok:
+            return r.content
+        raise BTGApiError(f"Resposta inesperada: {r.status_code} – {r.text}")
+    
+    # 2. Caso contrário tenta decodificar JSON
+
+    result = payload.get("result")
+    if result == "Processando":
+        raise BTGApiError("Processando")
+    
+    # 3. Quando pronto, result é JSON string com UrlDownload
+    if isinstance(result, str):
+        try:
+            info: Dict[str, str] = json.loads(result)
+            url = info["UrlDownload"]
+            return _download_url(url)
+        except Exception as exc:
+            raise BTGApiError(f"Falha ao interpretar result: {exc}") from exc
+
+    raise BTGApiError("Formato de resposta desconhecido")
+
+
+def await_report_ticket_result(token: str, ticket: str, *, attempts: int = 10,
+                               interval: int = 15) -> bytes:
+    """Espera até que o relatório esteja pronto e devolve conteúdo binário.
+    
+    Args:
+        token: Token de autenticação.
+        ticket: Ticket da requisição.
+        attempts: Número de tentativas.
+        interval: Intervalo entre tentativas em segundos.
+    
+    Returns:
+        Conteúdo binário do relatório (arquivo ZIP).
+    
+    Raises:
+        BTGApiError: Se o relatório não ficar pronto ou falhar.
+    """
+    for i in range(attempts):
+        try:
+            return check_report_ticket(token, ticket)
+        except BTGApiError as err:
+            if "Processando" in str(err):
+                logger.debug("Ticket %s pendente (%d/%d)", ticket, i + 1, attempts)
+                time.sleep(interval)
+                continue
+            raise
+    raise BTGApiError("Relatório não ficou pronto no tempo limite")
+
+
+def process_zip_to_dfs(zip_bytes: bytes) -> dict[str, pd.DataFrame]:
+    """Extrai todos os arquivos do ZIP e devolve DataFrames por nome."""
+    out: dict[str, pd.DataFrame] = {}
+    with zipfile.ZipFile(io.BytesIO(zip_bytes)) as zf:
+        for name in zf.namelist():
+            if name.endswith("/"):
+                continue
+            out[name] = read_bytes(zf.read(name), filename=name)
+    
+    return out
+
+
+def request_investors_transactions_report( token: str, query_date: dt.date, *,
+        distributors: list[str] | None = None, fund_names: list[str] | None = None,
+        consolidate_by_account: bool = True, page_size: int = 100) -> str:
+    """
+    Gera um ticket para o relatório de transações de cotistas (RTA).
+    Args:
+        token: Token de autenticação.
+        query_date: Data da consulta.
+        distributors: Lista de nomes de distribuidores (opcional).
+        fund_names: Lista de nomes de fundos (opcional).
+        consolidate_by_account: Consolidar por conta (default True).
+        page_size: Tamanho da página (default 100).
+        
+    Retorna *ticket* (string) a ser usado em `await_report_ticket_result`.
+    """
+    body = {
+        "contract": {
+            "distributors": distributors or [],
+            "queryDate": f"{query_date.isoformat()}T00:00:00Z",
+            "accountNumber": "",
+            "consolidateByAccount": str(consolidate_by_account).lower(),
+            "fundNames": fund_names or [],
+        },
+        "pageSize": page_size,
+        "webhookEndpoint": "string",
+    }
+
+    r = requests.post(
+        _INVESTOR_TX_ENDPOINT,
+        headers={"X-SecureConnect-Token": token, "Content-Type": "application/json"},
+        json=body,
+        timeout=30,
+    )
+    if r.ok:
+        return r.json()["ticket"]
+    raise BTGApiError(
+        f"Erro InvestorTransactionsFileReport: {r.status_code} – {r.text}"
+    )

luxorasap-0.1.1/src/luxorasap/btgapi/trades.py

@@ -0,0 +1,181 @@
+import time
+from typing import List, Dict
+
+import pandas as pd
+import requests
+from loguru import logger
+
+from .auth import BTGApiError
+
+__all__ = [
+    "submit_offshore_equity_trades",
+    "get_submitted_transactions",
+    "await_transaction_ticket_result",
+]
+
+_EP_SUBMIT_TEST = "https://funds-uat.btgpactual.com/offshore/TradeOffShore/Equity"
+_EP_SUBMIT_PROD = "https://funds.btgpactual.com/offshore/TradeOffShore/Equity"
+_EP_TICKET_TEST = "https://funds-uat.btgpactual.com/offshore/Ticket"
+_EP_TICKET_PROD = "https://funds.btgpactual.com/offshore/Ticket"
+
+_MARKET_IDS = {
+    "equity": 20,
+    "future": 22,
+    "bonds": 24,
+    "repo": 28,
+    "portfolio_swap": 29,
+    "interest_rate_swap": 30,
+    "performance_swap": 31,
+    "variance_swap": 32,
+    "equity_option": 33,
+    "future_option": 34,
+    "fx_option_vanilla": 35,
+    "fx_option_barrier": 36,
+    "fx": 25,
+}
+
+
+def submit_offshore_equity_trades(token: str, trades: list[dict], *, test_env: bool = True) -> str:
+    """
+    Submete lista de trades de Equity Offshore para a API do BTG.
+
+    Args:
+        token: Token de autenticação.
+        trades: Lista de dicionários representando os trades. Cada dict deve ter
+            a estrutura esperada pela API. Modelo:
+            [{
+                "currency": "USD",
+                "price": "60.12",
+                "productCodeValue": "...",
+                "glAccount": "...",
+                "primeBroker": "...",
+                "side": "Buy",
+                "tradeQuantity": "1000",
+                "commissionAmount": "12.50",
+                "settlementCurrency": "USD",
+                "fXRate": "1.0",
+                "externalReference": "TRADE-001",
+                "counterparty": "...",
+                "fundNickname": "my_fund",
+                "orderIdentification": "...",
+                "book": "some_book",
+                "tradeDate": "2025-02-19T16:03:53.596Z"
+                }]
+
+        test_env: Ambiente de teste (True) ou produção (False).
+
+    Returns:
+        Ticket da requisição.
+
+    Raises:
+        BTGApiError: Se a requisição falhar.
+        
+    """
+    url = _EP_SUBMIT_TEST if test_env else _EP_SUBMIT_PROD
+    r = requests.post(
+        url,
+        headers={
+            "X-SecureConnect-Token": token,
+            "Content-Type": "application/json-patch+json",
+        },
+        json={"results": trades},
+        timeout=30,
+    )
+    if r.status_code in (200, 201):
+        ticket = r.json()["ticket"]
+        logger.debug("Trades submetidos, ticket %s", ticket)
+        return ticket
+    raise BTGApiError(f"Falha no submit: {r.status_code} – {r.text}")
+
+
+def get_submitted_transactions(token: str, *, ticket_id: str = "", start_date: str = "",
+        end_date: str = "", market: str = "", test_env: bool = True) -> Dict:
+    """Consulta status detalhado de ticket ou filtro de datas/mercado.
+    Args:
+        token: Token de autenticação.
+        ticket_id: ID do ticket (opcional).
+        start_date: Data de início (opcional, formato YYYY-MM-DD).
+        end_date: Data de fim (opcional, formato YYYY-MM-DD).
+        market: Mercado (opcional. Valores válidos: "equity", "future", "bonds", "repo",
+            "portfolio_swap", "interest_rate_swap", "performance_swap", "variance_swap",
+            "equity_option", "future_option", "fx_option_vanilla", "fx_option_barrier", "fx"]).
+        test_env: Ambiente de teste (True) ou produção (False).
+
+    Returns:
+        Dicionário com os dados da resposta.
+
+    Raises:
+        BTGApiError: Se a requisição falhar ou a resposta for inválida.
+        
+    """
+
+    base_url = _EP_TICKET_TEST if test_env else _EP_TICKET_PROD
+
+    if ticket_id:
+        params = {"Ticket": ticket_id, "Detailed": "true"}
+    elif start_date and end_date and market:
+        params = {
+            "StartDate": start_date,
+            "EndDate": end_date,
+            "Market": _MARKET_IDS.get(market.lower(), market),
+            "Detailed": "true",
+        }
+    else:
+        raise BTGApiError("Forneça ticket_id OU start_date+end_date+market")
+
+    r = requests.get(
+        base_url,
+        headers={"X-SecureConnect-Token": token},
+        params=params,
+        timeout=30,
+    )
+    try:
+        return r.json()
+    except Exception as exc:
+        raise BTGApiError(f"Resposta inválida: {r.status_code}") from exc
+
+
+def await_transaction_ticket_result( token: str, ticket_id: str, *, attempts: int = 10,
+        interval: int = 30, test_env: bool = True) -> pd.DataFrame:
+    """Espera a conclusão do ticket e devolve DataFrame com metadados.
+    Args:
+        token: Token de autenticação.
+        ticket_id: ID do ticket.
+        attempts: Número de tentativas.
+        interval: Intervalo entre tentativas em segundos.
+        test_env: Ambiente de teste (True) ou produção (False).
+
+    Returns:
+        DataFrame com o status detalhado das transações.
+
+    Raises:
+        BTGApiError: Se o ticket não for finalizado ou falhar.
+        
+    """
+
+    cols = ["Status", "Ticket", "TradeId", "Env", "Msg"]
+    results = pd.DataFrame(columns=cols)
+
+    for i in range(attempts):
+        data = get_submitted_transactions(token, ticket_id=ticket_id, test_env=test_env)
+        trades_info = data["trades"]
+        ticket_status = trades_info[0]["Status"].lower()
+
+        # ambiente de produção pode ficar em pendente; aguardamos
+        if ticket_status == "pendente":
+            logger.debug("Ticket %s pendente (%d/%d)", ticket_id, i + 1, attempts)
+            time.sleep(interval)
+            continue
+
+        trades = trades_info[0]["Details"]["TicketDetalhesEquity"]
+        for tr in trades:
+            results.loc[len(results)] = [
+                tr["stateItemFile"].lower(),
+                ticket_id.lower(),
+                tr["externalReference"],
+                "test" if test_env else "prod",
+                tr["mensagens"],
+            ]
+        return results
+
+    raise BTGApiError("Ticket não finalizado no tempo limite")