PYield 0.36.0__tar.gz → 0.36.2__tar.gz

{pyield-0.36.0 → pyield-0.36.2}/.gitignore

@@ -36,4 +36,6 @@ ENV/
 *.ipynb
 
 # Dev folder
-dev/
+dev/
+
+site/   

{pyield-0.36.0 → pyield-0.36.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PYield
-Version: 0.36.0
+Version: 0.36.2
 Summary: A Python library for analysis of fixed income instruments in Brazil
 Project-URL: Source, https://github.com/crdcj/PYield
 Author-email: Carlos Carvalho <cr.cj@outlook.com>

pyield-0.36.2/pyield/__about__.py

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

{pyield-0.36.0 → pyield-0.36.2}/pyield/anbima/imaq.py

@@ -60,6 +60,7 @@ def _fetch_url_tables(target_date: pd.Timestamp) -> pd.DataFrame:
         decimal=",",
         displayed_only=True,
         dtype_backend="numpy_nullable",
+        na_values="--",
     )
 
     df = (
@@ -95,9 +96,15 @@ def _fetch_url_tables(target_date: pd.Timestamp) -> pd.DataFrame:
 def _process_df(df: pd.DataFrame) -> pd.DataFrame:
     df = df.rename(columns=COLUMN_MAPPING)[COLUMN_MAPPING.values()]
     df["Maturity"] = pd.to_datetime(df["Maturity"], format="%d/%m/%Y")
-    # Remove the thousands unit from numeric columns
+
     for col in ["MarketQuantity", "MarketValue", "QuantityVariation"]:
-        df[col] = (1000 * df[col]).astype("Int64")
+        # Fallback to string conversion in case conversion failed during read_csv
+        if df[col].dtype == "string" or df[col].dtype == "object":
+            df[col] = df[col].str.replace(".", "", regex=False).replace(",", ".")
+            df[col] = pd.to_numeric(df[col], errors="coerce")
+
+        # Remove the thousands unit from numeric columns
+        df[col] *= (1000 * df[col]).astype("Int64")
 
     return df
 

{pyield-0.36.0 → pyield-0.36.2}/pyield/bc/auction.py

@@ -14,6 +14,7 @@ import requests
 
 from pyield import bday
 from pyield import date_converter as dc
+from pyield.bc import ptax
 from pyield.date_converter import DateScalar
 from pyield.retry import default_retry
 from pyield.tn.ntnb import duration as duration_b
@@ -176,7 +177,7 @@ def _add_dv01(df: pd.DataFrame) -> pd.DataFrame:
     df["DV01SR"] = dv01 * df["AcceptedQuantitySR"]
 
     for col in ["DV01", "DV01FR", "DV01SR"]:
-        # Definiri DV01 nulos do leilão como 0
+        # Definrir DV01 nulos do leilão como 0
         df[col] = df[col].fillna(0).round(2)
 
     # Forçar 0 nas LFT, pois não há DV01
@@ -185,6 +186,24 @@ def _add_dv01(df: pd.DataFrame) -> pd.DataFrame:
     return df
 
 
+def _get_ptax_df(start_date: pd.Timestamp | None = None) -> pd.DataFrame:
+    # A série de leilões começa em 2007
+    df = ptax.ptax_series(start=start_date)[["Date", "MidRate"]]
+    df = df.rename(columns={"MidRate": "PTAX"})
+    return df
+
+
+def _add_usd_dv01(df: pd.DataFrame) -> pd.DataFrame:
+    ptax_start_date = df["Date"].min()
+    df_ptax = _get_ptax_df(start_date=ptax_start_date)
+    df = pd.merge_asof(left=df, right=df_ptax)
+    dv01_cols = [c for c in df.columns if c.startswith("DV01")]
+    for col in dv01_cols:
+        df[f"{col}USD"] = df[col] / df["PTAX"]
+
+    return df.drop(columns=["PTAX"])
+
+
 def _add_avg_maturity(df: pd.DataFrame) -> pd.DataFrame:
     # Na metodolgia do Tesouro Nacional, a maturidade média é a mesma que a duração
     df["AvgMaturity"] = df["Duration"]
@@ -221,6 +240,9 @@ def _sort_and_reorder_columns(df: pd.DataFrame) -> pd.DataFrame:
         "DV01",
         "DV01FR",
         "DV01SR",
+        "DV01USD",
+        "DV01FRUSD",
+        "DV01SRUSD",
         "AvgPrice",
         "CutPrice",
         "AvgRate",
@@ -242,6 +264,7 @@ def _fetch_df_from_url(url: str) -> pd.DataFrame:
         df = _process_df(df)
         df = _add_duration(df)
         df = _add_dv01(df)
+        df = _add_usd_dv01(df)
         df = _add_avg_maturity(df)
         df = _sort_and_reorder_columns(df)
         return df
@@ -304,38 +327,57 @@ def auctions(
             especificados. Em caso de erro ao buscar os dados, um DataFrame vazio
             é retornado e uma mensagem de erro é registrada no log.
 
+    Examples:
+        >>> import pandas as pd
+        >>> from pyield import bc
+        >>> df = bc.auctions(start="03-06-2025", end="03-06-2025")
+        >>> df
+                Date Settlement AuctionType  ...      CutPrice   AvgRate   CutRate
+        0 2025-06-03 2025-06-04       Venda  ...  16653.010815  0.000589  0.000589
+        1 2025-06-03 2025-06-04       Venda  ...  16572.063672   0.00109   0.00109
+        2 2025-06-03 2025-06-04       Venda  ...   4314.142451   0.07569   0.07569
+        3 2025-06-03 2025-06-04       Venda  ...    4140.47255   0.07312   0.07312
+        4 2025-06-03 2025-06-04       Venda  ...   3960.619508   0.07157   0.07157
+        ...
+
     Notes:
         FR = First Round (Primeira Rodada)
+
         SR = Second Round (Segunda Rodada)
 
-        O DataFrame possui as seguintes colunas:
-            - Date: Data do leilão.
-            - Settlement: Data de liquidação do leilão.
-            - AuctionType: Tipo de leilão (ex: "Sell" ou "Buy").
-            - Ordinance: Edital normativo associado ao leilão.
-            - Buyer: Categoria do comprador (ex: "TodoMercado", "SomenteDealerApto").
-            - BondType: Categoria do título (ex: "LTN", "LFT", "NTN-B", "NTN-F").
-            - SelicCode: Código do título no sistema Selic.
-            - Maturity: Data de vencimento do título.
-            - DV01: Valor do DV01 total do leilão em R$.
-            - DV01FR: DV01 da Primeira Rodada (FR) em R$.
-            - DV01SR: DV01 da Segunda Rodada (SR) em R$.
-            - AvgMaturity: Maturidade média do título (em anos).
-            - Value: Valor total do leilão em R$ (FR + SR).
-            - ValueFR: Valor da primeira rodada (FR) do leilão em R$.
-            - ValueSR: Valor da segunda rodada (SR) em R$.
-            - OfferedQuantity: Quantidade total ofertada no leilão (FR + SR).
-            - OfferedQuantityFR: Quantidade ofertada na primeira rodada (FR).
-            - OfferedQuantitySR: Quantidade ofertada na segunda rodada (SR).
-            - AcceptedQuantity: Quantidade total aceita no leilão (FR + SR).
-            - AcceptedQuantityFR: Quantidade aceita na primeira rodada (FR).
-            - AcceptedQuantitySR: Quantidade aceita na segunda rodada (SR).
-            - AvgPrice: Preço médio no leilão.
-            - CutPrice: Preço de corte.
-            - AvgRate: Taxa de juros média.
-            - CutRate: Taxa de corte.
-            - BDToMat: Dias úteis até o vencimento.
-            - Duration: Duration (Duração) do título.
+    DataFrame Columns:
+        - Date: Data do leilão.
+        - Settlement: Data de liquidação do leilão.
+        - AuctionType: Tipo de leilão (ex: "Sell" ou "Buy").
+        - Ordinance: Edital normativo associado ao leilão.
+        - Buyer: Categoria do comprador (ex: "TodoMercado", "SomenteDealerApto").
+        - BondType: Categoria do título (ex: "LTN", "LFT", "NTN-B", "NTN-F").
+        - SelicCode: Código do título no sistema Selic.
+        - Maturity: Data de vencimento do título.
+        - DV01: Valor do DV01 total do leilão em R$.
+        - DV01FR: DV01 da Primeira Rodada (FR) em R$.
+        - DV01SR: DV01 da Segunda Rodada (SR) em R$.
+        - DV01USD: DV01 total do leilão em dólares (USD).
+        - DV01FRUSD: DV01 da Primeira Rodada (FR) em dólares (USD).
+        - DV01SRUSD: DV01 da Segunda Rodada (SR) em dólares (USD).
+        - AvgMaturity: Maturidade média do título (em anos).
+        - Value: Valor total do leilão em R$ (FR + SR).
+        - ValueFR: Valor da primeira rodada (FR) do leilão em R$.
+        - ValueSR: Valor da segunda rodada (SR) em R$.
+        - OfferedQuantity: Quantidade total ofertada no leilão (FR + SR).
+        - OfferedQuantityFR: Quantidade ofertada na primeira rodada (FR).
+        - OfferedQuantitySR: Quantidade ofertada na segunda rodada (SR).
+        - AcceptedQuantity: Quantidade total aceita no leilão (FR + SR).
+        - AcceptedQuantityFR: Quantidade aceita na primeira rodada (FR).
+        - AcceptedQuantitySR: Quantidade aceita na segunda rodada (SR).
+        - AvgPrice: Preço médio no leilão.
+        - CutPrice: Preço de corte.
+        - AvgRate: Taxa de juros média.
+        - CutRate: Taxa de corte.
+        - BDToMat: Dias úteis entre a data de liquidação da 1R e a data de
+            vencimento do título.
+        - Duration: Duration (Duração) calculada com base na data de
+            liquidação da 1R e na data de vencimento do título.
     """
     url = BASE_API_URL
     if start:
@@ -351,6 +393,7 @@ def auctions(
     # Mapeamento do auction_type para o valor esperado pela API
     auction_type_mapping = {"sell": "Venda", "buy": "Compra"}
     if auction_type:
+        auction_type = str(auction_type).lower()
         auction_type_api_value = auction_type_mapping[auction_type]
         # Adiciona o parâmetro tipoOferta à URL se auction_type for fornecido
         url += f"&@tipoOferta='{auction_type_api_value}'"

pyield-0.36.2/pyield/tn/__init__.py

@@ -0,0 +1,3 @@
+from pyield.tn.benchmark import benchmarks
+
+__all__ = ["benchmarks"]

pyield-0.36.0/pyield/tn/auction.py → pyield-0.36.2/pyield/tn/benchmark.py

@@ -9,12 +9,12 @@ logger = logging.getLogger(__name__)
 
 TIMEZONE_BZ = ZoneInfo("America/Sao_Paulo")
 
-BENCHMARKS_COLUMN_MAPPING = {
-    "BENCHMARK": "Benchmark",
-    "VENCIMENTO": "MaturityDate",
-    "TÍTULO": "BondType",
+COLUMN_MAPPING = {
     "INÍCIO": "StartDate",
     "TERMINO": "EndDate",
+    "TÍTULO": "BondType",
+    "VENCIMENTO": "MaturityDate",
+    "BENCHMARK": "Benchmark",
 }
 
 
@@ -61,12 +61,12 @@ def benchmarks(include_history: bool = False) -> pd.DataFrame:
         >>> # Get historical benchmarks
         >>> df_history = tn.benchmarks(include_history=True)
         >>> df_history.head()
-            Benchmark   MaturityDate BondType  StartDate    EndDate
-        0  LFT 6 anos   2020-03-01      LFT 2014-01-01 2014-06-30
-        1  LFT 6 anos   2020-09-01      LFT 2014-07-01 2014-12-31
-        2  LFT 6 anos   2021-03-01      LFT 2015-01-01 2015-04-30
-        3  LFT 6 anos   2021-09-01      LFT 2015-05-01 2015-12-31
-        4  LFT 6 anos   2022-03-01      LFT 2016-01-01 2016-06-30
+           StartDate    EndDate BondType MaturityDate     Benchmark
+        0 2014-01-01 2014-06-30      LFT   2020-03-01    LFT 6 anos
+        1 2014-01-01 2014-06-01      LTN   2014-10-01   LTN 6 meses
+        2 2014-01-01 2014-06-30      LTN   2015-04-01  LTN 12 meses
+        3 2014-01-01 2014-06-30      LTN   2016-04-01  LTN 24 meses
+        4 2014-01-01 2014-06-30      LTN   2018-01-01  LTN 48 meses
     """
     session = requests.Session()
     include_history_param_value = "S" if include_history else "N"
@@ -127,4 +127,10 @@ def benchmarks(include_history: bool = False) -> pd.DataFrame:
             "No current benchmark data found after filtering by active period."
         )
 
-    return df.rename(columns=BENCHMARKS_COLUMN_MAPPING)
+    column_order = [c for c in COLUMN_MAPPING if c in df.columns]
+    return (
+        df[column_order]
+        .rename(columns=COLUMN_MAPPING)
+        .sort_values(["StartDate", "BondType", "MaturityDate"])
+        .reset_index(drop=True)
+    )

{pyield-0.36.0 → pyield-0.36.2}/pyproject.toml

@@ -15,7 +15,7 @@ classifiers = [
 ]
 dependencies = [
     "pandas[html, parquet]>=2.0.0",
-    "numpy>=2.0.0",    
+    "numpy>=2.0.0",
     "requests>=2.31.0",
     "tenacity>=9.0.0",
 ]
@@ -32,8 +32,8 @@ dev = [
     "mkdocs",
     "mkdocs-material",
     "mkdocstrings[python]",
-    "mkdocs-autorefs",    
-    "types-requests", 
+    "mkdocs-autorefs",
+    "types-requests",
     "pandas-stubs",
     "lxml-stubs",
     "ruff",
@@ -50,19 +50,4 @@ path = "pyield/__about__.py"
 only-include = ["pyield"]
 
 [tool.uv]
-package = true
-
-[tool.ruff]
-line-length = 88
-indent-width = 4
-target-version = "py312"
-extend-include = ["*.ipynb"]
-
-[tool.ruff.lint]
-preview = true
-select = ["I", "F", "E", "W", "PL", "PT"]
-
-[tool.ruff.format]
-docstring-code-format = true
-docstring-code-line-length = 88
-
+package = true

pyield-0.36.0/pyield/__about__.py

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

pyield-0.36.0/pyield/tn/__init__.py

@@ -1,3 +0,0 @@
-from pyield.tn.auction import benchmarks
-
-__all__ = ["benchmarks"]