luxorasap 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

luxorasap/__init__.py

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

luxorasap/btgapi/__init__.py

@@ -1,7 +1,7 @@
 """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 .reports import request_portfolio, await_report_ticket_result, process_zip_to_dfs, request_investors_transactions_report, request_fundflow_report
 from .trades import submit_offshore_equity_trades, await_transaction_ticket_result
 
 __all__ = [
@@ -12,5 +12,6 @@ __all__ = [
     "submit_offshore_equity_trades",
     "await_transaction_ticket_result",
     "process_zip_to_dfs",
-    "request_investors_transactions_report"
+    "request_investors_transactions_report",
+    "request_fundflow_report",
 ]

luxorasap/btgapi/reports.py

@@ -16,7 +16,8 @@ __all__ = [
     "check_report_ticket",
     "await_report_ticket_result",
     "process_zip_to_dfs",
-    "request_investors_transactions_report"
+    "request_investors_transactions_report",
+    "request_fundflow_report"
 ]
 
 _REPORT_ENDPOINT = "https://funds.btgpactual.com/reports/Portfolio"
@@ -24,6 +25,7 @@ _TICKET_ENDPOINT = "https://funds.btgpactual.com/reports/Ticket"
 _INVESTOR_TX_ENDPOINT = (
     "https://funds.btgpactual.com/reports/RTA/InvestorTransactionsFileReport"
 )
+_FUNDFLOW_ENDPOINT = "https://funds.btgpactual.com/reports/RTA/FundFlow"
 _REPORT_TYPES = {"excel": 10, "xml5": 81, "pdf": 2}
 
 
@@ -105,6 +107,15 @@ def check_report_ticket(token: str, ticket: str, *, page: Optional[int] = None)
             return _download_url(url)
         except Exception as exc:
             raise BTGApiError(f"Falha ao interpretar resultado: {exc}") from exc
+    
+    # 4. result pode ser uma lista de dados
+    if isinstance(result, list):
+        # Vamos tentar transformar num dataframe e retornar
+        try:
+            df = pd.DataFrame(result)
+            return df
+        except Exception as exc:
+            raise BTGApiError(f"Falha ao converter resultado em DataFrame: {exc}") from exc
 
     raise BTGApiError("Formato de resposta desconhecido")
 
@@ -186,4 +197,43 @@ def request_investors_transactions_report( token: str, query_date: dt.date, *,
         return r.json()["ticket"]
     raise BTGApiError(
         f"Erro InvestorTransactionsFileReport: {r.status_code} – {r.text}"
-    )
+    )
+    
+    
+def request_fundflow_report( token: str, start_date: dt.date,
+        end_date: dt.date, *, fund_name: str = "", date_type: str = "LIQUIDACAO", page_size: int = 100) -> str:
+    """Dispara geração do **Fund Flow** (RTA) e devolve *ticket*.
+
+    Args:
+        token: JWT obtido via :pyfunc:`luxorasap.btgapi.get_access_token`.
+        start_date,end_date: Datas do intervalo desejado.
+        fund_name: Nome do fundo conforme BTG. String vazia retorna as movimentacoes para todos os fundos.
+        date_type: Enum da API (`LIQUIDACAO`, `MOVIMENTO`, etc.).
+        page_size: Página retornada por chamada (default 100).
+
+    Returns
+    -------
+    str
+        ID do ticket a ser acompanhado em :pyfunc:`await_fundflow_ticket_result`.
+    """
+
+    body = {
+        "contract": {
+            "startDate": f"{start_date}T00:00:00Z",
+            "endDate": f"{end_date}T00:00:00Z",
+            "dateType": date_type,
+            "fundName": fund_name,
+        },
+        "pageSize": page_size,
+        "webhookEndpoint": "string",
+    }
+
+    r = requests.post(
+        _FUNDFLOW_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 FundFlow: {r.status_code} - {r.text}")

luxorasap/ingest/cloud/__init__.py

@@ -20,8 +20,15 @@ def save_table(
     index_name: str = "index",
     normalize_columns: bool = True,
     directory: str = "enriched/parquet",
+    override=False
 ):
     """Salva DataFrame como Parquet em ADLS (sobrescrevendo)."""
+    
+    if override == False:
+        lq = LuxorQuery()
+        if lq.table_exists(table_name):
+            return
+    
     df = prep_for_save(df, index=index, index_name=index_name, normalize=normalize_columns)
     _client.write_df(df.astype(str), f"{directory}/{table_name}.parquet")
 

luxorasap-0.1.4.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: luxorasap
+Version: 0.1.4
+Summary: Toolbox da Luxor para ingestão, análise e automação de dados financeiros.
+Author-email: Luxor Group <backoffice@luxor.com.br>
+License: Proprietary – All rights reserved
+Project-URL: Homepage, https://github.com/luxor-group/luxor-asap
+Project-URL: Documentation, https://luxor-group.github.io/luxorasap-docs/
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.2
+Requires-Dist: numpy>=1.25
+Requires-Dist: loguru>=0.7
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: azure-storage-blob>=12.19
+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: luxorasap[dataframe,storage]; extra == "datareader"
+Requires-Dist: numpy>=1.25; extra == "datareader"
+Requires-Dist: scipy>=1.13; extra == "datareader"
+Provides-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"
+Requires-Dist: pre-commit>=3.7; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+
+# 🧠 LuxorASAP
+
+**Luxor Automatic System for Assets and Portfolios** é o toolbox oficial da Luxor para automação de pipelines de dados, integração com APIs financeiras e gerenciamento eficiente de dados patrimoniais no Azure.
+
+Projetado para ser rápido, reutilizável e seguro, este pacote unifica a ingestão, leitura e transformação de dados utilizados nas análises e marcações do time de investimentos.
+
+---
+
+## 🚀 Funcionalidades
+
+- 📡 Integração com a API de relatórios e boletas do BTG Pactual
+- 🗂️ Carregamento padronizado de arquivos (Excel, Parquet, Blob)
+- 💾 Escrita incremental e segura no ADLS (Azure Blob Storage)
+- 📊 Análises de preço, retorno e risco com API de consulta (`LuxorQuery`)
+- 🔗 Modularidade entre `btgapi`, `datareader`, `ingest`, `utils`
+
+---
+
+## 🧩 Estrutura do Projeto
+
+```
+luxor-asap/
+├── src/luxorasap/
+│   ├── btgapi/          # Integração com BTG Pactual
+│   ├── datareader/      # Interface de leitura e análise de dados
+│   ├── ingest/          # Carga de dados no ADLS
+│   └── utils/           # Funções auxiliares (parquet, dataframe)
+└── tests/               # Testes automatizados com Pytest
+```
+
+---
+
+## 📚 Documentação
+
+A documentação externa completa está disponível em:
+
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://luxor-group.github.io/luxorasap-docs/)
+
+---
+
+## 🔧 Requisitos
+
+- Python 3.9+
+- Azure Blob Storage configurado
+- Variáveis de ambiente via `.env` (ou passadas manualmente):
+
+```bash
+AZURE_STORAGE_CONNECTION_STRING=...
+BTG_CLIENT_ID=...
+BTG_CLIENT_SECRET=...
+```
+
+---
+
+## 📦 Instalação
+
+Para instalar localmente:
+
+```bash
+pip install -e .
+```
+
+Ou via PyPI (futuramente):
+
+```bash
+pip install luxor-asap
+```
+
+---
+
+## 🧪 Testes
+
+```bash
+pytest -v
+```
+
+---
+
+## 📄 Licença
+
+Projeto de uso interno do Luxor Group. Todos os direitos reservados.

{luxorasap-0.1.2.dist-info → luxorasap-0.1.4.dist-info}/RECORD

@@ -1,12 +1,12 @@
-luxorasap/__init__.py,sha256=Y5nnDcLGJ3_HtgLuOZcpM_FwSUlFBjrylPnr8xjAPIw,1355
-luxorasap/btgapi/__init__.py,sha256=DISzvHp-J7oeNq_PhmCt-_ZRBCaUgkQ9k2wtJLm-kgs,563
+luxorasap/__init__.py,sha256=Xu98QKHj58869cmqwa66NfiErmqdcMbkOodYam0bq5k,1355
+luxorasap/btgapi/__init__.py,sha256=QUlfb5oiBY6K1Q5x4-a-x2wECe1At5wc2962I5odOJk,620
 luxorasap/btgapi/auth.py,sha256=2TLKZdVlJgfSItOvB7GoPnH6gndkWWqSIyE4VDSYRgo,1873
-luxorasap/btgapi/reports.py,sha256=WSuJws9foki4i6URa9muKasOvzD6G11b-GVKvl9V5BA,6186
+luxorasap/btgapi/reports.py,sha256=UEk5QAl4cS6vdxXyliyg-weT0C1mILE1bqilPRDuHPE,7975
 luxorasap/btgapi/trades.py,sha256=1Cn1RMjaHO073YHJFeN2XRxYElQH7A98GIfUVy0VmSg,5987
 luxorasap/datareader/__init__.py,sha256=41RAvbrQ4R6oj67S32CrKqolx0CJ2W8cbOF6g5Cqm2g,120
 luxorasap/datareader/core.py,sha256=LpXe5g4lZpfEqaz_gjjHizVA-vPEjBi5yJKg_7K0Nkw,153205
 luxorasap/ingest/__init__.py,sha256=XhxDTN2ar-u6UCPhnxNU_to-nWiit-SpQ6cA_N9eMSs,795
-luxorasap/ingest/cloud/__init__.py,sha256=MfnEYUav0AD6oxs92ghE8TtxdqcQkb_VB6z706m-2nw,1727
+luxorasap/ingest/cloud/__init__.py,sha256=lbb3GweA8m0mQuH64HCKwO5FLwih4orU7i9KNhWWAkk,1867
 luxorasap/ingest/legacy_local/dataloader.py,sha256=zKPhuiBSFwkuWN6d8g2s60KkbVk1R_1cGMCtQM9j-0c,11908
 luxorasap/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 luxorasap/utils/dataframe/__init__.py,sha256=dU_RwTTOi6F3mlhM-0MYWM_qexBN9BmmKc_yrDE1Lwc,207
@@ -14,8 +14,8 @@ luxorasap/utils/dataframe/reader.py,sha256=Vzjdw-AeS1lnWEHQ8RZNh0kK93NWTp0NWVi_B
 luxorasap/utils/dataframe/transforms.py,sha256=Bm_cv9L9923QIXH82Fa_M4pM94f2AJRPu62Vv_i7tto,1684
 luxorasap/utils/storage/__init__.py,sha256=U3XRq94yzRp3kgBSUcRzs2tQgJ4o8h8a1ZzwiscA5XM,67
 luxorasap/utils/storage/blob.py,sha256=pcEixGxwXM9y5iPPpkX__ySWq0milghJGketYZlRL-0,3171
-luxorasap-0.1.2.dist-info/METADATA,sha256=imZHJdmbV6ClMwMi29J3rsJTmfVZ7bip5S_aW9ew6Xk,6994
-luxorasap-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-luxorasap-0.1.2.dist-info/entry_points.txt,sha256=XFh-dOwUhlya9DmGvgookMI0ezyUJjcOvTIHDEYS44g,52
-luxorasap-0.1.2.dist-info/top_level.txt,sha256=9YOL6bUIpzY06XFBRkUW1e4rgB32Ds91fQPGwUEjxzU,10
-luxorasap-0.1.2.dist-info/RECORD,,
+luxorasap-0.1.4.dist-info/METADATA,sha256=fAlSiOlV6N-7StRT8-csAKfi3CvNPzmxCe45rpcbDeg,3796
+luxorasap-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+luxorasap-0.1.4.dist-info/entry_points.txt,sha256=XFh-dOwUhlya9DmGvgookMI0ezyUJjcOvTIHDEYS44g,52
+luxorasap-0.1.4.dist-info/top_level.txt,sha256=9YOL6bUIpzY06XFBRkUW1e4rgB32Ds91fQPGwUEjxzU,10
+luxorasap-0.1.4.dist-info/RECORD,,

luxorasap-0.1.2.dist-info/METADATA

@@ -1,241 +0,0 @@
-Metadata-Version: 2.4
-Name: luxorasap
-Version: 0.1.2
-Summary: Luxor’s unified toolbox for data ingestion, querying and analytics.
-Author-email: Luxor Group <backoffice@luxor.com.br>
-License: Proprietary – All rights reserved
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: Other/Proprietary License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: pandas>=2.2
-Requires-Dist: numpy>=1.25
-Requires-Dist: loguru>=0.7
-Requires-Dist: python-dotenv>=1.0
-Requires-Dist: azure-storage-blob>=12.19
-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: luxorasap[dataframe,storage]; extra == "datareader"
-Requires-Dist: numpy>=1.25; extra == "datareader"
-Requires-Dist: scipy>=1.13; extra == "datareader"
-Provides-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"
-Requires-Dist: pre-commit>=3.7; extra == "dev"
-Requires-Dist: build>=1.2; extra == "dev"
-
-# 📚 Documentação LuxorASAP
-
-> Guia do desenvolvedor para os subpacotes **datareader**, **ingest**, **btgapi** e **utils**.
->
-> • Instalação rápida  • Visão arquitetural  • APIs detalhadas  • Exemplos de uso  • Extras opcional
-
----
-
-## Índice
-
-1. [Visão Geral](#visao-geral)
-2. [Instalação](#instalacao)
-3. [utils](#utils)
-4. [datareader](#datareader)
-5. [ingest](#ingest)
-6. [btgapi](#btgapi)
-7. [Roadmap & Contribuições](#roadmap)
-
----
-
-## 1. Visão Geral
-
-LuxorASAP é o *toolbox* unificado da Luxor para ingestão, consulta e automação de dados financeiros.
-
-| Subpacote      | Função‑chave                                                          | Extras PyPI            |
-| -------------- | --------------------------------------------------------------------- | ---------------------- |
-| **utils**      | Utilidades puras (I/O ADLS, transformação de DataFrame, decorators)   | `storage`, `dataframe` |
-| **datareader** | Consulta de preços/tabelas no data lake via `LuxorQuery`              | `datareader`           |
-| **ingest**     | Carga de dados nova (parquet/zip/excel) em ADLS + loader legado       | `ingest`               |
-| **btgapi**     | Wrapper autenticado para as APIs do BTG Pactual (relatórios & trades) | `btgapi`               |
-
----
-
-## 2. Instalação
-
-```bash
-# core + leitura de dados
-pip install luxorasap[datareader]
-
-# tudo incluído (leitura, ingest, btg)
-pip install luxorasap[datareader,ingest,btgapi]
-
-# desenvolvimento
-pip install -e ".[dev]"
-```
-
-Extras podem ser combinados à vontade (`luxorasap[storage]`, etc.).
-
-Configuração obrigatória do **ADLS**:
-
-```bash
-export AZURE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=..."
-```
-
----
-
-## 3. utils
-
-Camada de utilidades **sem dependências internas**.
-
-### 3.1 storage.BlobParquetClient
-
-```python
-from luxorasap.utils.storage import BlobParquetClient
-client = BlobParquetClient(container="luxorasap")
-
-# write
-client.write_df(df, "bronze/parquet/mytable.parquet")
-
-# read (tuple -> DataFrame, success_flag)
-df, ok = client.read_df("bronze/parquet/mytable.parquet")
-```
-
-### 3.2 dataframe
-
-```python
-from luxorasap.utils.dataframe import prep_for_save, persist_column_formatting, read_bytes
-
-df2 = prep_for_save(df, index=True, index_name="ID", normalize=True)
-```
-
-### 3.3 decorators & misc
-
-`with_retry`, `chunkify`, `timer`… ficam em *utils.helpers* (caso precise).
-
----
-
-## 4. datareader
-
-### 4.1 Visão rápida
-
-```python
-from luxorasap.datareader import LuxorQuery
-lq = LuxorQuery()
-
-# DataFrame completo
-df = lq.get_table("assets")
-
-# Série de preços diária
-aapl = lq.get_prices("aapl us equity", start="2025-01-01", end="2025-03-31")
-
-# Preço pontual
-price = lq.get_price("aapl us equity", on="2025-03-31")
-```
-
-*Caching*: `@lru_cache(maxsize=32)` evita hits repetidos ao Blob.
-
-### 4.2 Métodos-chave
-
-| Método                                          | Descrição                     |
-| ----------------------------------------------- | ----------------------------- |
-| `table_exists(name)`                            | checa metadados no ADLS       |
-| `get_table(name)`                               | DataFrame completo (cached)   |
-| `get_prices(asset, start, end, column="Price")` | `pd.Series`                   |
-| `get_price(asset, on)`                          | preço pontual (float ou None) |
-
----
-
-## 5. ingest
-
-### 5.1 ingest.cloud (novo)
-
-```python
-from luxorasap.ingest import save_table, incremental_load
-from luxorasap.datareader import LuxorQuery
-
-save_table("trades", df)
-
-lq = LuxorQuery()
-incremental_load(lq, "prices_daily", df_new, increment_column="Date")
-```
-
-### 5.2 ingest.legacy\_local
-
-```python
-from luxorasap.ingest import DataLoader   # Deprecado – ainda funcional
-```
-
-*Decoration*: ao importar `DataLoader` você verá `DeprecationWarning`.
-
----
-
-## 6. btgapi
-
-### 6.1 Autenticação
-
-```python
-from luxorasap.btgapi import get_access_token
-TOKEN = get_access_token(test_env=True)
-```
-
-### 6.2 Relatórios – Portfolio & Investor Transactions
-
-```python
-from luxorasap.btgapi.reports import (
-    request_portfolio, await_report_ticket_result, process_zip_to_dfs,
-    request_investors_transactions_report,
-)
-
-ticket = request_portfolio(TOKEN, "LUXOR FUND - CLASS A",
-                           start=dt.date(2025,1,1), end=dt.date(2025,1,31))
-zip_bytes = await_report_ticket_result(TOKEN, ticket)
-carteiras = process_zip_to_dfs(zip_bytes)
-```
-
-### 6.3 Trades offshore
-
-```python
-from luxorasap.btgapi.trades import (
-    submit_offshore_equity_trades,
-    await_transaction_ticket_result,
-)
-
-ticket = submit_offshore_equity_trades(TOKEN, trades=[{...}], test_env=True)
-status_df = await_transaction_ticket_result(TOKEN, ticket, test_env=True)
-```
-
-### 6.4 Extras
-
-* `BTGApiError` — exceção customizada para qualquer falha.
-
----
-
-## 7. Roadmap & Contribuições
-
-* **Remover** `ingest.legacy_local` quando não houver mais dependências.
-* Suporte a partições Parquet (delta‑like) na gravação.
-* Adicionar `pydantic` para validar contratos BTG.
-* Pull requests bem‑vindos!  Rode `make lint && pytest -q` antes de enviar.
-
----
-
-### Contatos
-
-* Dados / Back‑Office – [backoffice@luxor.com.br](mailto:backoffice@luxor.com.br)
-* Mantenedor principal – Sergio