luxorasap 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
luxorasap/__init__.py CHANGED
@@ -13,7 +13,7 @@ from types import ModuleType
13
13
  try:
14
14
  __version__: str = metadata.version(__name__)
15
15
  except metadata.PackageNotFoundError: # editable install
16
- __version__ = "0.1.3"
16
+ __version__ = "0.1.5"
17
17
 
18
18
  # ─── Lazy loader ─────────────────────────────────────────────────
19
19
  def __getattr__(name: str) -> ModuleType:
@@ -0,0 +1,128 @@
1
+ Metadata-Version: 2.4
2
+ Name: luxorasap
3
+ Version: 0.1.5
4
+ Summary: Toolbox da Luxor para ingestão, análise e automação de dados financeiros.
5
+ Author-email: Luxor Group <backoffice@luxor.com.br>
6
+ License: Proprietary – All rights reserved
7
+ Project-URL: Homepage, https://github.com/luxor-group/luxor-asap
8
+ Project-URL: Documentation, https://luxor-group.github.io/luxorasap-docs/
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: License :: Other/Proprietary License
11
+ Classifier: Operating System :: OS Independent
12
+ Requires-Python: >=3.9
13
+ Description-Content-Type: text/markdown
14
+ Requires-Dist: pandas>=2.2
15
+ Requires-Dist: numpy>=1.25
16
+ Requires-Dist: loguru>=0.7
17
+ Requires-Dist: python-dotenv>=1.0
18
+ Requires-Dist: azure-storage-blob>=12.19
19
+ Requires-Dist: pyarrow>=15.0
20
+ Requires-Dist: requests>=2.32
21
+ Requires-Dist: pydantic>=2.7
22
+ Requires-Dist: scipy>=1.13
23
+ Requires-Dist: openpyxl
24
+ Provides-Extra: storage
25
+ Requires-Dist: azure-storage-blob>=12.19; extra == "storage"
26
+ Requires-Dist: pyarrow>=15.0; extra == "storage"
27
+ Provides-Extra: dataframe
28
+ Requires-Dist: pandas>=2.2; extra == "dataframe"
29
+ Provides-Extra: datareader
30
+ Requires-Dist: luxorasap[dataframe,storage]; extra == "datareader"
31
+ Requires-Dist: numpy>=1.25; extra == "datareader"
32
+ Requires-Dist: scipy>=1.13; extra == "datareader"
33
+ Provides-Extra: ingest
34
+ Requires-Dist: luxorasap[dataframe,storage]; extra == "ingest"
35
+ Requires-Dist: pandas>=2.2; extra == "ingest"
36
+ Provides-Extra: btgapi
37
+ Requires-Dist: requests>=2.32; extra == "btgapi"
38
+ Requires-Dist: pydantic>=2.7; extra == "btgapi"
39
+ Provides-Extra: dev
40
+ Requires-Dist: pytest>=8.2; extra == "dev"
41
+ Requires-Dist: requests-mock>=1.11; extra == "dev"
42
+ Requires-Dist: black>=24.4.0; extra == "dev"
43
+ Requires-Dist: isort>=5.13; extra == "dev"
44
+ Requires-Dist: bumpver>=2024.3; extra == "dev"
45
+ Requires-Dist: pre-commit>=3.7; extra == "dev"
46
+ Requires-Dist: build>=1.2; extra == "dev"
47
+
48
+ # 🧠 LuxorASAP
49
+
50
+ **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.
51
+
52
+ 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.
53
+
54
+ ---
55
+
56
+ ## 🚀 Funcionalidades
57
+
58
+ - 📡 Integração com a API de relatórios e boletas do BTG Pactual
59
+ - 🗂️ Carregamento padronizado de arquivos (Excel, Parquet, Blob)
60
+ - 💾 Escrita incremental e segura no ADLS (Azure Blob Storage)
61
+ - 📊 Análises de preço, retorno e risco com API de consulta (`LuxorQuery`)
62
+ - 🔗 Modularidade entre `btgapi`, `datareader`, `ingest`, `utils`
63
+
64
+ ---
65
+
66
+ ## 🧩 Estrutura do Projeto
67
+
68
+ ```
69
+ luxor-asap/
70
+ ├── src/luxorasap/
71
+ │ ├── btgapi/ # Integração com BTG Pactual
72
+ │ ├── datareader/ # Interface de leitura e análise de dados
73
+ │ ├── ingest/ # Carga de dados no ADLS
74
+ │ └── utils/ # Funções auxiliares (parquet, dataframe)
75
+ └── tests/ # Testes automatizados com Pytest
76
+ ```
77
+
78
+ ---
79
+
80
+ ## 📚 Documentação
81
+
82
+ A documentação externa completa está disponível em:
83
+
84
+ [![Docs](https://img.shields.io/badge/docs-online-blue)](https://luxorinvestimentos.github.io/luxorasap-docs/)
85
+
86
+ ---
87
+
88
+ ## 🔧 Requisitos
89
+
90
+ - Python 3.9+
91
+ - Azure Blob Storage configurado
92
+ - Variáveis de ambiente via `.env` (ou passadas manualmente):
93
+
94
+ ```bash
95
+ AZURE_STORAGE_CONNECTION_STRING=...
96
+ BTG_CLIENT_ID=...
97
+ BTG_CLIENT_SECRET=...
98
+ ```
99
+
100
+ ---
101
+
102
+ ## 📦 Instalação
103
+
104
+ Para instalar localmente:
105
+
106
+ ```bash
107
+ pip install -e .
108
+ ```
109
+
110
+ Ou via PyPI:
111
+
112
+ ```bash
113
+ pip install luxor-asap
114
+ ```
115
+
116
+ ---
117
+
118
+ ## 🧪 Testes
119
+
120
+ ```bash
121
+ pytest -v
122
+ ```
123
+
124
+ ---
125
+
126
+ ## 📄 Licença
127
+
128
+ Projeto de uso interno do Luxor Group. Todos os direitos reservados.
@@ -1,4 +1,4 @@
1
- luxorasap/__init__.py,sha256=Zv3_ZOZLgZtlPZbbKiM743UmDx6FN7-iHv4U5qUlro4,1355
1
+ luxorasap/__init__.py,sha256=L9c_OhMFnxhZW7Q2X83VIfZMQKhT2wfmsGgHJxsbB1M,1355
2
2
  luxorasap/btgapi/__init__.py,sha256=QUlfb5oiBY6K1Q5x4-a-x2wECe1At5wc2962I5odOJk,620
3
3
  luxorasap/btgapi/auth.py,sha256=2TLKZdVlJgfSItOvB7GoPnH6gndkWWqSIyE4VDSYRgo,1873
4
4
  luxorasap/btgapi/reports.py,sha256=UEk5QAl4cS6vdxXyliyg-weT0C1mILE1bqilPRDuHPE,7975
@@ -14,8 +14,8 @@ luxorasap/utils/dataframe/reader.py,sha256=Vzjdw-AeS1lnWEHQ8RZNh0kK93NWTp0NWVi_B
14
14
  luxorasap/utils/dataframe/transforms.py,sha256=Bm_cv9L9923QIXH82Fa_M4pM94f2AJRPu62Vv_i7tto,1684
15
15
  luxorasap/utils/storage/__init__.py,sha256=U3XRq94yzRp3kgBSUcRzs2tQgJ4o8h8a1ZzwiscA5XM,67
16
16
  luxorasap/utils/storage/blob.py,sha256=pcEixGxwXM9y5iPPpkX__ySWq0milghJGketYZlRL-0,3171
17
- luxorasap-0.1.3.dist-info/METADATA,sha256=gom3LK0bhLeQS83_rCGv7xfmw6MnoFPzh46tL5jNqwg,6994
18
- luxorasap-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
19
- luxorasap-0.1.3.dist-info/entry_points.txt,sha256=XFh-dOwUhlya9DmGvgookMI0ezyUJjcOvTIHDEYS44g,52
20
- luxorasap-0.1.3.dist-info/top_level.txt,sha256=9YOL6bUIpzY06XFBRkUW1e4rgB32Ds91fQPGwUEjxzU,10
21
- luxorasap-0.1.3.dist-info/RECORD,,
17
+ luxorasap-0.1.5.dist-info/METADATA,sha256=sHRGTD6wFOp7BaNpAn2DZsKEkdnVPBckq_eIZKTS5NQ,3789
18
+ luxorasap-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
19
+ luxorasap-0.1.5.dist-info/entry_points.txt,sha256=XFh-dOwUhlya9DmGvgookMI0ezyUJjcOvTIHDEYS44g,52
20
+ luxorasap-0.1.5.dist-info/top_level.txt,sha256=9YOL6bUIpzY06XFBRkUW1e4rgB32Ds91fQPGwUEjxzU,10
21
+ luxorasap-0.1.5.dist-info/RECORD,,
@@ -1,241 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: luxorasap
3
- Version: 0.1.3
4
- Summary: Luxor’s unified toolbox for data ingestion, querying and analytics.
5
- Author-email: Luxor Group <backoffice@luxor.com.br>
6
- License: Proprietary – All rights reserved
7
- Classifier: Programming Language :: Python :: 3
8
- Classifier: License :: Other/Proprietary License
9
- Classifier: Operating System :: OS Independent
10
- Requires-Python: >=3.9
11
- Description-Content-Type: text/markdown
12
- Requires-Dist: pandas>=2.2
13
- Requires-Dist: numpy>=1.25
14
- Requires-Dist: loguru>=0.7
15
- Requires-Dist: python-dotenv>=1.0
16
- Requires-Dist: azure-storage-blob>=12.19
17
- Requires-Dist: pyarrow>=15.0
18
- Requires-Dist: requests>=2.32
19
- Requires-Dist: pydantic>=2.7
20
- Requires-Dist: scipy>=1.13
21
- Requires-Dist: openpyxl
22
- Provides-Extra: storage
23
- Requires-Dist: azure-storage-blob>=12.19; extra == "storage"
24
- Requires-Dist: pyarrow>=15.0; extra == "storage"
25
- Provides-Extra: dataframe
26
- Requires-Dist: pandas>=2.2; extra == "dataframe"
27
- Provides-Extra: datareader
28
- Requires-Dist: luxorasap[dataframe,storage]; extra == "datareader"
29
- Requires-Dist: numpy>=1.25; extra == "datareader"
30
- Requires-Dist: scipy>=1.13; extra == "datareader"
31
- Provides-Extra: ingest
32
- Requires-Dist: luxorasap[dataframe,storage]; extra == "ingest"
33
- Requires-Dist: pandas>=2.2; extra == "ingest"
34
- Provides-Extra: btgapi
35
- Requires-Dist: requests>=2.32; extra == "btgapi"
36
- Requires-Dist: pydantic>=2.7; extra == "btgapi"
37
- Provides-Extra: dev
38
- Requires-Dist: pytest>=8.2; extra == "dev"
39
- Requires-Dist: requests-mock>=1.11; extra == "dev"
40
- Requires-Dist: black>=24.4.0; extra == "dev"
41
- Requires-Dist: isort>=5.13; extra == "dev"
42
- Requires-Dist: bumpver>=2024.3; extra == "dev"
43
- Requires-Dist: pre-commit>=3.7; extra == "dev"
44
- Requires-Dist: build>=1.2; extra == "dev"
45
-
46
- # 📚 Documentação LuxorASAP
47
-
48
- > Guia do desenvolvedor para os subpacotes **datareader**, **ingest**, **btgapi** e **utils**.
49
- >
50
- > • Instalação rápida • Visão arquitetural • APIs detalhadas • Exemplos de uso • Extras opcional
51
-
52
- ---
53
-
54
- ## Índice
55
-
56
- 1. [Visão Geral](#visao-geral)
57
- 2. [Instalação](#instalacao)
58
- 3. [utils](#utils)
59
- 4. [datareader](#datareader)
60
- 5. [ingest](#ingest)
61
- 6. [btgapi](#btgapi)
62
- 7. [Roadmap & Contribuições](#roadmap)
63
-
64
- ---
65
-
66
- ## 1. Visão Geral
67
-
68
- LuxorASAP é o *toolbox* unificado da Luxor para ingestão, consulta e automação de dados financeiros.
69
-
70
- | Subpacote | Função‑chave | Extras PyPI |
71
- | -------------- | --------------------------------------------------------------------- | ---------------------- |
72
- | **utils** | Utilidades puras (I/O ADLS, transformação de DataFrame, decorators) | `storage`, `dataframe` |
73
- | **datareader** | Consulta de preços/tabelas no data lake via `LuxorQuery` | `datareader` |
74
- | **ingest** | Carga de dados nova (parquet/zip/excel) em ADLS + loader legado | `ingest` |
75
- | **btgapi** | Wrapper autenticado para as APIs do BTG Pactual (relatórios & trades) | `btgapi` |
76
-
77
- ---
78
-
79
- ## 2. Instalação
80
-
81
- ```bash
82
- # core + leitura de dados
83
- pip install luxorasap[datareader]
84
-
85
- # tudo incluído (leitura, ingest, btg)
86
- pip install luxorasap[datareader,ingest,btgapi]
87
-
88
- # desenvolvimento
89
- pip install -e ".[dev]"
90
- ```
91
-
92
- Extras podem ser combinados à vontade (`luxorasap[storage]`, etc.).
93
-
94
- Configuração obrigatória do **ADLS**:
95
-
96
- ```bash
97
- export AZURE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=..."
98
- ```
99
-
100
- ---
101
-
102
- ## 3. utils
103
-
104
- Camada de utilidades **sem dependências internas**.
105
-
106
- ### 3.1 storage.BlobParquetClient
107
-
108
- ```python
109
- from luxorasap.utils.storage import BlobParquetClient
110
- client = BlobParquetClient(container="luxorasap")
111
-
112
- # write
113
- client.write_df(df, "bronze/parquet/mytable.parquet")
114
-
115
- # read (tuple -> DataFrame, success_flag)
116
- df, ok = client.read_df("bronze/parquet/mytable.parquet")
117
- ```
118
-
119
- ### 3.2 dataframe
120
-
121
- ```python
122
- from luxorasap.utils.dataframe import prep_for_save, persist_column_formatting, read_bytes
123
-
124
- df2 = prep_for_save(df, index=True, index_name="ID", normalize=True)
125
- ```
126
-
127
- ### 3.3 decorators & misc
128
-
129
- `with_retry`, `chunkify`, `timer`… ficam em *utils.helpers* (caso precise).
130
-
131
- ---
132
-
133
- ## 4. datareader
134
-
135
- ### 4.1 Visão rápida
136
-
137
- ```python
138
- from luxorasap.datareader import LuxorQuery
139
- lq = LuxorQuery()
140
-
141
- # DataFrame completo
142
- df = lq.get_table("assets")
143
-
144
- # Série de preços diária
145
- aapl = lq.get_prices("aapl us equity", start="2025-01-01", end="2025-03-31")
146
-
147
- # Preço pontual
148
- price = lq.get_price("aapl us equity", on="2025-03-31")
149
- ```
150
-
151
- *Caching*: `@lru_cache(maxsize=32)` evita hits repetidos ao Blob.
152
-
153
- ### 4.2 Métodos-chave
154
-
155
- | Método | Descrição |
156
- | ----------------------------------------------- | ----------------------------- |
157
- | `table_exists(name)` | checa metadados no ADLS |
158
- | `get_table(name)` | DataFrame completo (cached) |
159
- | `get_prices(asset, start, end, column="Price")` | `pd.Series` |
160
- | `get_price(asset, on)` | preço pontual (float ou None) |
161
-
162
- ---
163
-
164
- ## 5. ingest
165
-
166
- ### 5.1 ingest.cloud (novo)
167
-
168
- ```python
169
- from luxorasap.ingest import save_table, incremental_load
170
- from luxorasap.datareader import LuxorQuery
171
-
172
- save_table("trades", df)
173
-
174
- lq = LuxorQuery()
175
- incremental_load(lq, "prices_daily", df_new, increment_column="Date")
176
- ```
177
-
178
- ### 5.2 ingest.legacy\_local
179
-
180
- ```python
181
- from luxorasap.ingest import DataLoader # Deprecado – ainda funcional
182
- ```
183
-
184
- *Decoration*: ao importar `DataLoader` você verá `DeprecationWarning`.
185
-
186
- ---
187
-
188
- ## 6. btgapi
189
-
190
- ### 6.1 Autenticação
191
-
192
- ```python
193
- from luxorasap.btgapi import get_access_token
194
- TOKEN = get_access_token(test_env=True)
195
- ```
196
-
197
- ### 6.2 Relatórios – Portfolio & Investor Transactions
198
-
199
- ```python
200
- from luxorasap.btgapi.reports import (
201
- request_portfolio, await_report_ticket_result, process_zip_to_dfs,
202
- request_investors_transactions_report,
203
- )
204
-
205
- ticket = request_portfolio(TOKEN, "LUXOR FUND - CLASS A",
206
- start=dt.date(2025,1,1), end=dt.date(2025,1,31))
207
- zip_bytes = await_report_ticket_result(TOKEN, ticket)
208
- carteiras = process_zip_to_dfs(zip_bytes)
209
- ```
210
-
211
- ### 6.3 Trades offshore
212
-
213
- ```python
214
- from luxorasap.btgapi.trades import (
215
- submit_offshore_equity_trades,
216
- await_transaction_ticket_result,
217
- )
218
-
219
- ticket = submit_offshore_equity_trades(TOKEN, trades=[{...}], test_env=True)
220
- status_df = await_transaction_ticket_result(TOKEN, ticket, test_env=True)
221
- ```
222
-
223
- ### 6.4 Extras
224
-
225
- * `BTGApiError` — exceção customizada para qualquer falha.
226
-
227
- ---
228
-
229
- ## 7. Roadmap & Contribuições
230
-
231
- * **Remover** `ingest.legacy_local` quando não houver mais dependências.
232
- * Suporte a partições Parquet (delta‑like) na gravação.
233
- * Adicionar `pydantic` para validar contratos BTG.
234
- * Pull requests bem‑vindos! Rode `make lint && pytest -q` antes de enviar.
235
-
236
- ---
237
-
238
- ### Contatos
239
-
240
- * Dados / Back‑Office – [backoffice@luxor.com.br](mailto:backoffice@luxor.com.br)
241
- * Mantenedor principal – Sergio