bb_api 0.2.0__py3-none-any.whl

bb_api/common.py

@@ -0,0 +1,72 @@
+import re
+import pandas as pd
+from enum import Enum
+from typing import Any, Dict, NewType, Sequence, Union
+from datetime import date, datetime, timedelta
+
+_dese_oauth_domain = "https://oauth.desenv.bb.com.br"
+_homo_oauth_domain = "https://oauth.hm.bb.com.br"
+_homo_alt_oauth_domain = "https://oauth.sandbox.bb.com.br"
+_prod_oauth_domain = "https://oauth.bb.com.br"
+
+_dese_api_domain = "https://api.desenv.bb.com.br"
+_homo_api_domain = "https://api.hm.bb.com.br"
+_homo_alt_api_domain = "https://api.sandbox.bb.com.br"
+_prod_api_domain = "https://api.bb.com.br"
+
+_time_between_access_token_requests = timedelta(minutes=10)
+
+
+DateLike = NewType("DateLike", Union[str | date | datetime])
+
+
+class Ambiente(Enum):
+    DESENVOLVIMENTO = 0
+    HOMOLOGACAO = 1
+    HOMOLOGACAO_ALTERNATIVO = 2
+    PRODUCAO = 3
+
+
+def _get_headers(access_token: str) -> Dict:
+    return {
+        "Authorization": f"Bearer {access_token}",
+    }
+
+
+def _handle_numeric_string_with_symbols(v: str) -> str:
+    return re.sub(r"\D", "", v)
+
+
+def _handle_dates(v: DateLike) -> str:
+    if isinstance(v, str):
+        v = datetime.strptime(v, "%Y-%m-%d")
+    elif isinstance(v, date):
+        v = datetime.combine(v, datetime.min.time())
+
+    v = v.strftime("%Y-%m-%d")
+
+
+def _handle_results(
+    data: Any,
+    main_list: str = None,
+    insertables: Sequence[str] = None,
+    explodeables: Sequence[str] = None,
+    rename_dict: Dict[str, str] = None,
+) -> pd.DataFrame:
+    if main_list is not None:
+        df = pd.DataFrame(data[main_list])
+    else:
+        df = pd.DataFrame([data])
+
+    if insertables is not None:
+        for insertable in insertables:
+            df[insertable] = data[insertable]
+
+    if explodeables is not None:
+        for explodeable in explodeables:
+            df = df.explode(explodeable, ignore_index=True)
+
+    if rename_dict is not None:
+        df = df.rename(rename_dict, axis=1)
+
+    return df

bb_api-0.2.0.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: bb_api
+Version: 0.2.0
+Summary: Wrapper da API do Banco do Brasil.
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas>=3.0.1
+Requires-Dist: requests>=2.32.5
+Dynamic: license-file
+
+# Biblioteca API BB
+
+*Wrapper* da API do Banco do Brasil.
+
+## Como instalar?
+
+Se você usar o `uv`:
+
+```sh
+uv add bb_api
+```
+
+Se você usar o `pip`:
+
+```sh
+pip install bb_api
+```
+
+## Funcionalidades
+
+- Lê os parâmetros `app_key`, `client_id` e `client_secret` das variáveis de
+  ambiente `BB_API_APP_KEY`, `BB_API_CLIENT_ID` e `BB_API_CLIENT_SECRET`,
+  respectivamente, caso não sejam passadas na instanciação das classes
+- Gera o token de acesso automaticamente, gerando um novo a cada 10 minutos,
+  tempo de expiração do token definido pelo Banco do Brasil
+- Separa operaçãos disponíveis aos órgãos de repasse e de controle em classes
+  separadas, mantendo as operações comuns aos dois
+- Retorna os resultados das chamadas às APIS em formato de `DataFrame` do
+  [`pandas`][pandas]
+- Aceita parâmetros em múltiplos formatos, como:
+  - CNPJ e CEP podem estar pontuados ou não
+  - Datas podem estar em formato `str`, `date` ou `datetime`
+
+## Referências
+
+Os documentos utilizados de referência para criação dessa API foram:
+
+- [Portal Developers BB]
+- [Documentação Swagger API BB]
+
+[pandas]: https://pandas.pydata.org/
+[Portal Developers BB]: https://apoio.developers.bb.com.br/referency/post/641877548600960012b32cd6
+[Documentação Swagger API BB]: https://api.bb.com.br/accountability/v3/swagger

bb_api-0.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+bb_api/__init__.py,sha256=-FbqpkOfFWZEQRgbbWZPrg9CYTc5XlFycHq65LESC6Q,331
+bb_api/accountability.py,sha256=CzEge1l5ew9OzBNMmtRzU5tnJ0FcCBKY6DJWESxj_Fo,74213
+bb_api/common.py,sha256=B0_SxUV6TfVqtmB0w1I-VcvsW5Yl_3t7hmfuxeA3YM0,1901
+bb_api-0.2.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+bb_api-0.2.0.dist-info/METADATA,sha256=i74yovYQY3m1hikCkV5Kpvjs1vVOZeg4Mxq08zZq4xA,1588
+bb_api-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+bb_api-0.2.0.dist-info/top_level.txt,sha256=ZMdA0Lx6osrxQHw-iizi8tXTIofFtsg_qPApwC2xPOM,7
+bb_api-0.2.0.dist-info/RECORD,,

bb_api-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+