pyield 0.48.2__tar.gz → 0.48.3__tar.gz

{pyield-0.48.2 → pyield-0.48.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyield
-Version: 0.48.2
+Version: 0.48.3
 Summary: A Python library for analysis of fixed income instruments in Brazil
 Project-URL: Homepage, https://github.com/crdcj/PYield
 Project-URL: Documentation, https://crdcj.github.io/PYield

pyield-0.48.3/pyield/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.48.3"

pyield-0.48.3/pyield/ipca/__init__.py

@@ -0,0 +1,10 @@
+from pyield.ipca.historico import indices, indices_ultimos, taxas, taxas_ultimas
+from pyield.ipca.projetado import taxa_projetada
+
+__all__ = [
+    "indices",
+    "indices_ultimos",
+    "taxa_projetada",
+    "taxas",
+    "taxas_ultimas",
+]

{pyield-0.48.2 → pyield-0.48.3}/pyield/ipca/historico.py

@@ -121,7 +121,7 @@ def taxas(data_inicial: DateLike, data_final: DateLike) -> pl.DataFrame:
     return _buscar_periodo(data_inicial, data_final, _VAR_TAXA, em_percentual=True)
 
 
-def ultimas_taxas(qtd_meses: int = 1) -> pl.DataFrame:
+def taxas_ultimas(qtd_meses: int = 1) -> pl.DataFrame:
     """Obtém as últimas taxas mensais do IPCA.
 
     Realiza chamada à API do portal de dados do IBGE no formato:
@@ -143,14 +143,14 @@ def ultimas_taxas(qtd_meses: int = 1) -> pl.DataFrame:
     Examples:
         >>> from pyield import ipca
         >>> # Obter a taxa do IPCA do último mês
-        >>> df = ipca.ultimas_taxas(1)
+        >>> df = ipca.taxas_ultimas(1)
         >>> # Obter as taxas do IPCA dos últimos 3 meses
-        >>> df = ipca.ultimas_taxas(3)
+        >>> df = ipca.taxas_ultimas(3)
     """
     return _buscar_ultimos(qtd_meses, _VAR_TAXA, em_percentual=True)
 
 
-def ultimos_indices(qtd_meses: int = 1) -> pl.DataFrame:
+def indices_ultimos(qtd_meses: int = 1) -> pl.DataFrame:
     """Obtém os últimos valores do número-índice do IPCA.
 
     Realiza chamada à API do portal de dados do IBGE no formato:
@@ -172,9 +172,9 @@ def ultimos_indices(qtd_meses: int = 1) -> pl.DataFrame:
     Examples:
         >>> from pyield import ipca
         >>> # Obter o número-índice do IPCA do último mês
-        >>> df = ipca.ultimos_indices(1)
+        >>> df = ipca.indices_ultimos(1)
         >>> # Obter os números-índice do IPCA dos últimos 3 meses
-        >>> df = ipca.ultimos_indices(3)
+        >>> df = ipca.indices_ultimos(3)
     """
     return _buscar_ultimos(qtd_meses, _VAR_INDICE)
 

{pyield-0.48.2 → pyield-0.48.3}/pyield/tn/ntnc.py

@@ -83,7 +83,7 @@ def dados(data: DateLike) -> pl.DataFrame:
     )
 
     # Adiciona duration, prazo_medio, dv01, dv01_usd e taxa_di
-    df = utils.adicionar_duration(df, duracao)
+    df = utils.adicionar_duration(df, duration)
     df = utils.adicionar_dv01(df, data_ref)
     df = utils.adicionar_taxa_di(df, data_ref)
 
@@ -148,15 +148,13 @@ def datas_pagamento(
     liquidacao = conversores.converter_datas(data_liquidacao)
     vencimento = conversores.converter_datas(data_vencimento)
 
-    # Check if maturity date is after the start date
+    # Retorna vazio se vencimento for anterior à liquidação
     if vencimento < liquidacao:
         return pl.Series(name="datas_pagamento", dtype=pl.Date)
 
-    # Initialize loop variables
+    # Itera de trás para frente, do vencimento até a liquidação
     data_cupom = vencimento
     datas_cupons = []
-
-    # Iterate backwards from the maturity date to the settlement date
     while data_cupom > liquidacao:
         datas_cupons.append(data_cupom)
         # Retrocede 6 meses
@@ -227,7 +225,7 @@ def fluxos_caixa(
     valor_cupom = _obter_valor_cupom(vencimento)
     valor_final = _obter_valor_final(vencimento)
 
-    # Build dataframe and assign cash flows using Polars expressions
+    # Monta DataFrame com fluxos de caixa
     df = pl.DataFrame({"data_pagamento": serie_datas_pagamento}).with_columns(
         pl.when(pl.col("data_pagamento") == vencimento)
         .then(valor_final)
@@ -359,7 +357,7 @@ def taxa(
     return round(taxa_encontrada, 6)
 
 
-def duracao(
+def duration(
     data_liquidacao: DateLike,
     data_vencimento: DateLike,
     taxa: float,
@@ -377,7 +375,7 @@ def duracao(
 
     Examples:
         >>> from pyield import ntnc
-        >>> ntnc.duracao("21-03-2025", "01-01-2031", 0.067626)
+        >>> ntnc.duration("21-03-2025", "01-01-2031", 0.067626)
         4.405363320448
     """
     if any_is_empty(data_liquidacao, data_vencimento, taxa):

pyield-0.48.2/pyield/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.48.2"

pyield-0.48.2/pyield/ipca/__init__.py

@@ -1,10 +0,0 @@
-from pyield.ipca.historico import indices, taxas, ultimas_taxas, ultimos_indices
-from pyield.ipca.projetado import taxa_projetada
-
-__all__ = [
-    "indices",
-    "taxas",
-    "ultimas_taxas",
-    "ultimos_indices",
-    "taxa_projetada",
-]