tesorotools-python 0.0.8__tar.gz → 0.0.10__tar.gz

{tesorotools_python-0.0.8 → tesorotools_python-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tesorotools-python
-Version: 0.0.8
+Version: 0.0.10
 Requires-Dist: babel
 Requires-Dist: eikon
 Requires-Dist: lseg-data

{tesorotools_python-0.0.8 → tesorotools_python-0.0.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tesorotools-python"
-version = "0.0.8"
+version = "0.0.10"
 dependencies = ["psycopg2", "SQLAlchemy", "pandas", "matplotlib", "pyarrow", "python-docx", "openpyxl", "PyYAML", "babel", "eikon", "lseg-data"]
 
 [build-system]
@@ -9,5 +9,8 @@ build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/tesorotools"]
-artifacts = ["*.otf"]
-include = ["*.otf"]
+artifacts = ["src/tesorotools/assets/fonts/*.otf"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["src/tesorotools"]
+artifacts = ["src/tesorotools/assets/fonts/*.otf"]

tesorotools_python-0.0.10/tesorotools/__init__.py

@@ -0,0 +1,6 @@
+from tesorotools.artists.line_plot import Format, Legend, LinePlot
+from tesorotools.utils.config import TemplateLoader
+
+TemplateLoader.add_constructor("!line_plot", LinePlot.from_yaml)
+TemplateLoader.add_constructor("!format", Format.from_yaml)
+TemplateLoader.add_constructor("!legend", Legend.from_yaml)

tesorotools_python-0.0.10/tesorotools/artists/line_plot.py

@@ -0,0 +1,243 @@
+import datetime
+import locale
+from pathlib import Path
+from typing import Any, Self
+
+import matplotlib.pyplot as plt
+import pandas as pd
+from matplotlib.ticker import FuncFormatter
+from yaml.nodes import MappingNode
+
+from tesorotools.utils.config import TemplateLoader
+
+locale.setlocale(locale.LC_ALL, "")
+
+from tesorotools.utils.globals import DEBUG
+from tesorotools.utils.matplotlib import (
+    PLOT_CONFIG,
+    format_annotation,
+    load_fonts,
+)
+
+load_fonts()
+
+LINE_PLOT_CONFIG: dict[str, Any] = PLOT_CONFIG["line"]
+AX_CONFIG: dict[str, Any] = PLOT_CONFIG["ax"]
+FIG_CONFIG: dict[str, Any] = PLOT_CONFIG["figure"]
+
+
+def _style_spines(
+    ax: plt.Axes,
+    decimals: int,
+    units: str,
+    *,
+    color: str,
+    linewidth: str,
+):
+    ax.grid(visible=True, axis="y")
+    for spine in ax.spines.values():
+        spine.set_color(color)
+        spine.set_linewidth(linewidth)
+    ax.yaxis.tick_right()
+    ax.yaxis.set_major_formatter(
+        FuncFormatter(lambda y, _: format_annotation(y, decimals, units))
+    )
+    ax.set_xlabel("")
+
+    ax.tick_params(which="minor", size=0, width=0)
+    ax.tick_params(axis="both", which="major")
+    for tick in ax.get_xticklines():
+        tick.set_markeredgecolor(color)
+    for tick in ax.get_yticklines():
+        tick.set_markeredgecolor(color)
+
+
+def _style_baseline(ax: plt.Axes, reference: float = 0, **baseline_config):
+    color: str = baseline_config["color"]
+    bottom_lim, top_lim = ax.get_ylim()
+    ax.set_ylim(bottom=min(reference, bottom_lim), top=max(reference, top_lim))
+    bottom_lim, top_lim = ax.get_ylim()
+    if bottom_lim == reference:
+        ax.spines["bottom"].set_edgecolor(color)
+    elif top_lim == reference:
+        ax.spines["top"].set_edgecolor(color)
+    else:
+        ax.axhline(y=reference, **baseline_config)
+
+
+def plot_line_chart(
+    out_name: Path,
+    data: pd.DataFrame,
+    *,
+    base_100: bool,
+    annotate: bool,
+    format: dict[str, Any],
+    **kwargs,
+):
+    if base_100:
+        data = data / data.iloc[0, :] * 100
+    if format["units"] == "p.b.":
+        data = data * 100
+    fig = plt.figure(**FIG_CONFIG)
+    ax = fig.add_subplot()
+    data.plot(ax=ax)
+    if annotate:
+        pass
+
+    reference = 100 if base_100 else 0
+    _style_spines(ax, **format, **AX_CONFIG["spines"])
+    _style_baseline(ax, reference, **AX_CONFIG["baseline"])
+    ax.legend(
+        loc="upper center",
+        bbox_to_anchor=(0.5, LINE_PLOT_CONFIG["legend_sep"]),
+        ncol=(
+            kwargs["legend"]["ncol"]
+            if kwargs is not None and kwargs.get("legend", None) is not None
+            else LINE_PLOT_CONFIG["ncol"]
+        ),
+    )
+
+    fig.savefig(out_name)
+
+
+def plot_line_charts(data: pd.DataFrame, config_dicts: dict[str, Any]):
+    for name, config in config_dicts.items():
+        start_date: pd.Timestamp = pd.to_datetime(config["start_date"])
+        end_date_str: str | None = config["end_date"]
+        end_date: pd.Timestamp = (
+            data.index.max()
+            if end_date_str is None
+            else pd.to_datetime(end_date_str)
+        )
+        series: dict[str, str] = config["series"]
+        trimmed_data: pd.DataFrame = data.loc[
+            slice(start_date, end_date), series.keys()
+        ]
+        trimmed_data = trimmed_data.rename(columns=series)
+        out_name: Path = DEBUG / "line" / f"{name}.png"
+        plot_line_chart(out_name, trimmed_data, **config)
+
+
+class Format:
+    def __init__(self, units: str = "", decimals: int = 0):
+        self.units = units
+        self.decimals = decimals
+
+    @classmethod
+    def from_yaml(cls, loader: TemplateLoader, node: MappingNode) -> Self:
+        loader.flatten_mapping(node)
+        format_cfg: dict[str, Any] = loader.construct_mapping(node, deep=True)
+        format_cfg.pop("id")
+        return cls(**format_cfg)
+
+
+class Legend:
+    def __init__(self, ncol: int = 5, sep: float = -0.125):
+        self.ncol = ncol
+        self.sep = sep
+
+    @classmethod
+    def from_yaml(cls, loader: TemplateLoader, node: MappingNode) -> Self:
+        legend_cfg: dict[str, Any] = loader.construct_mapping(node, deep=True)
+        legend_cfg.pop("id")
+        return cls(**legend_cfg)
+
+
+# as more stuff is needed, seems wise to make a class
+class LinePlot:
+    def __init__(
+        self,
+        out_path: Path,
+        data_path: Path,
+        series: dict[str, str],
+        scale: float = 1,
+        start_date: datetime.datetime | None = None,
+        end_date: datetime.datetime | None = None,
+        base_100: bool = False,
+        annotate: bool = False,
+        baseline: bool = False,
+        format: Format | None = None,
+        legend: Legend | None = None,
+    ) -> None:
+
+        if out_path.suffix != ".png":
+            raise ValueError(f"The out file {out_path} should be a .png file")
+        self.out_path = out_path
+
+        if data_path.suffix != ".feather":
+            raise ValueError(
+                f"The data file {data_path} must be a .feather file"
+            )
+        self.data = pd.read_feather(data_path)
+
+        self.base_100 = base_100
+        self.annotate = annotate  # unused for the moment
+        self.format = format
+        self.start_date = start_date
+        self.end_date = end_date
+        self.series = series
+        self.legend = legend
+        self.baseline = baseline
+        self.scale = scale
+
+    @classmethod
+    def from_yaml(cls, loader: TemplateLoader, node: MappingNode) -> Self:
+        line_plot_cfg: dict[str, Any] = loader.construct_mapping(
+            node, deep=True
+        )
+        line_plot_cfg.pop("id")
+        line_plot_cfg["out_path"] = Path(line_plot_cfg["out_path"])
+        line_plot_cfg["data_path"] = Path(line_plot_cfg["data_path"])
+        return cls(**line_plot_cfg)
+
+    def plot(self) -> plt.Axes:
+        start_date: pd.Timestamp = (
+            self.data.index.min()
+            if self.start_date is None
+            else pd.to_datetime(self.start_date)
+        )
+
+        end_date: pd.Timestamp = (
+            self.data.index.max()
+            if self.end_date is None
+            else pd.to_datetime(self.end_date)
+        )
+
+        plot_data: pd.DataFrame = self.data.loc[
+            slice(start_date, end_date), self.series.keys()
+        ]
+        plot_data = plot_data.rename(columns=self.series)
+
+        plot_data = plot_data * self.scale
+
+        if self.base_100:  # maybe more flexible in the future
+            plot_data = plot_data / plot_data.iloc[0, :] * 100
+
+        fig = plt.figure(**FIG_CONFIG)
+        ax = fig.add_subplot()
+        plot_data.plot(ax=ax)
+
+        if self.annotate:  # not implemented yet
+            pass
+
+        _style_spines(  # maybe make this function accept a Format object
+            ax,
+            decimals=self.format.decimals,
+            units=self.format.units,
+            **AX_CONFIG["spines"],
+        )
+        if self.baseline:
+            reference = 100 if self.base_100 else 0
+            _style_baseline(ax, reference, **AX_CONFIG["baseline"])
+
+        if self.legend is not None:
+            ax.legend(
+                loc="upper center",
+                bbox_to_anchor=(0.5, LINE_PLOT_CONFIG["legend_sep"]),
+                ncol=self.legend.ncol,
+            )
+        else:
+            ax.legend().set_visible(False)
+
+        fig.savefig(self.out_path)
+        return ax

tesorotools_python-0.0.8/README.md

@@ -1,55 +0,0 @@
-# Especificación de un documento
-
-## Generar los *assets* de un semanal (fase de transición)
-1. Poner en la carpeta [debug](debug) el archivo [flash.feather](debug/flash.feather) generado por el *script* `generar_semanal.py` de `dev2`. Será necesario cambiar a la rama `semanal` con un `git switch semanal`. Recordar revertir este cambio.
-2. `python -m tesorotools.convert`
-3. `python -m tesorotools.main`
-
-## Plantilla
-
-- Debe ser un archivo `.yaml`
-- Si no se especifica nada, el programa buscará un archivo llamado `template.yaml` en la carpeta desde donde se esté ejecutando. En caso de no encontrarlo, lanzará un error.
-
-### Headline
-*Opcional*. Consta de dos entradas, también *opcionales* `title` y `comment`.
-
-#### Ejemplo
-```yaml
-headline:
-  title: Apertura
-  comment: El precio del chocolate con almendras se dispara
-```
-
-Se renderizará en el estilo `Title` o `Título` del documento base de word proporcionado.
-
-### Introduction
-*Opcional*. Consta de dos entradas, también *opcionales* `date` y `hour`.
-
-- `date`: Fecha en formato `AAAA-MM-DD`, con o sin comillas.
-- `hour`: Hora en formato `HH:MM`, **siempre** entre comillas.
-
-#### Ejemplo
-```yaml
-introduction:
-  date: 2025-01-31
-  hour: "15:30"
-```
-
-La fecha se renderizará en el estilo `Subtitle` o `Subtítulo` del documento base de word proporcionado.
-
-# Descripción de la estructura y el funcionamiento
-
-## Funcionamiento
-- Se *leen* las plantillas del documento.
-- Una vez leídas sabemos:
-  - Qué es lo que hay que descargar, de dónde y con qué fechas.
-  - Qué es lo que hay que calcular a partir de lo descargado y cómo.
-- Descarga *missing*
-  - Debe haber una opción *debug*, así como opción de no descargar y tomar directamente de nuestra bbdd.
-- Cálculo o *prerrenderizado*: se generan las imágenes de los gráficos así como los archivos necesarios para renderizar las tablas en su formato final.
-- *Renderizado* final.
-
-## Informes
-- Un *informe* (*Report*) es una **clase** que contiene un diccionario de *contenidos* (*Content*)
-- Un *cotenido* (*Content*) es un **protocolo** que permite consultar y modificar su *nivel de anidamiento* así como construirse a partir de un archivo `.yaml`.
-- Un informe puede *rederizarse* a un documento word a partir de una **plantilla**. Sencillamente, renderizará todos sus componentes uno por uno.

tesorotools_python-0.0.8/examples/README.md

@@ -1,24 +0,0 @@
-## Tablas
-
-### Columnas
-
-- `name`: Nombre de la columna a mostrar.
-
-- `scale`: Número por el que se multiplica el valor original en la base de datos a la hora de ser mostrado.
-- `unit`: Símbolo de la unidad del valor a mostrar.
-- `decimals`: Número de decimales a mostrar.
-
-- `show_units_in_title`: Se mostrará el símbolo de las unidades en el título de la columna.
-- `show_units_in_cell`: Se mostrará el símbolo de las unidades al lado del valor de cada celda.
-
-Variables de localización de los valores a mostrar en la base de datos.
-
-- `offset`:
-- `difference`: 
-- `stat`: 
-
-Variables de coloreado.
-
-- `colors`: Indica si el valor debe ir coloreado o no en la tabla.
-- `positive_good`: Si es `True` colorearemos los valores positivos de un color que el lector asocie con "*bueno*".
-- `outliers`: Si es `True` sombrearemos las celdas que tengan un valor por encima de cierto umbral.

tesorotools_python-0.0.8/examples/barh_plots.yaml

@@ -1,202 +0,0 @@
-.alemania_series:
-  PT10YT=RR_DIFF: DE10YT=RR
-  GR10YT=RR_DIFF: DE10YT=RR
-  ES10YT=RR_DIFF: DE10YT=RR
-  EUUNIEURAE10Y=_DIFF: DE10YT=RR
-  IT10YT=RR_DIFF: DE10YT=RR
-  FR10YT=RR_DIFF: DE10YT=RR
-
-.flash: &flash
-  date: 
-
-.perc_format: &perc_format
-  units: "%"
-  decimals: 2
-
-.pb_format: &pb_format
-  units: "p.b."
-  decimals: 0
-
-.bancos: &bancos
-  sorted: True
-  blocks:
-    bancos_esp:
-      label: Bancos españoles
-      series:
-        BKT.MC: Bankinter
-        SAN.MC: Santander
-        CABK.MC: Caixabank
-        SABE.MC: Sabadell
-        BBVA.MC: BBVA
-        UNI.MC: Unicaja
-    bandos_idx:
-      label: Índices bancarios internacionales
-      series:
-        .IBCA.MA: Índice bancario español*
-        .SX7E: EuroStoxx Banks
-        .FTNMX301010: Índice bancario UK
-        .SPXBK: S&P 500 Bancos EEUU
-        .DJUSBK: DJ US Banks
-        .DJSRBKT: DJ US Regional Banks
-  format:
-    <<: *perc_format
-    decimals: 0
-  annot_format:
-    <<: *perc_format
-
-bancos_week:
-  flash:
-    <<: *flash
-    deviations: True
-    offset: ftd
-    difference: relative
-  <<: *bancos
-
-bancos_mtd:
-  flash:
-    <<: *flash
-    deviations: False
-    offset: mtd
-    difference: relative
-  <<: *bancos
-
-.deuda_general: &deuda_general
-  sorted: True
-  series:
-    EUUNIEURAE10Y=: UE
-    ES10YT=RR: España*
-    DE10YT=RR: Alemania
-    FR10YT=RR: Francia
-    IT10YT=RR: Italia
-    PT10YT=RR: Portugal
-    GR10YT=RR: Grecia
-    GB10YT=RR: Reino Unido
-    US10YT=RR: EEUU
-  format:
-    <<: *pb_format
-  annot_format:
-    <<: *pb_format
-  axis_format:
-    <<: *perc_format
-
-deuda_general_week:
-  flash:
-    <<: *flash
-    offset: ftd
-    difference: absolute
-    deviations: True
-  <<: *deuda_general
-
-deuda_general_ytd:
-  flash:
-    <<: *flash
-    offset: ytd
-    difference: absolute
-    deviations: False
-  <<: *deuda_general
-
-.deuda_diferenciales: &deuda_diferenciales
-  sorted: True
-  series:
-    PT10YT=RR_DIFF: Portugal
-    GR10YT=RR_DIFF: Grecia
-    ES10YT=RR_DIFF: España*
-    EUUNIEURAE10Y=_DIFF: UE
-    IT10YT=RR_DIFF: Italia
-    FR10YT=RR_DIFF: Francia
-  format:
-    <<: *pb_format
-  annot_format:
-    <<: *pb_format
-  axis_format:
-    <<: *pb_format
-
-deuda_diferenciales_week:
-  flash:
-    <<: *flash
-    offset: ftd
-    difference: absolute
-    deviations: True
-  <<: *deuda_diferenciales
-
-deuda_diferenciales_ytd:
-  flash:
-    <<: *flash
-    offset: ytd
-    difference: absolute
-    deviations: False
-  <<: *deuda_diferenciales
-
-.deuda_esp: &deuda_esp
-  sorted: False
-  series:
-    ES1YT=RR: 1 años
-    ES2YT=RR: 2 años
-    ES3YT=RR: 3 años
-    ES5YT=RR: 5 años
-    ES10YT=RR: 10 años*
-    ES30YT=RR: 30 años
-  format:
-    <<: *pb_format
-  annot_format:
-    <<: *pb_format
-  axis_format:
-    <<: *perc_format
-
-deuda_esp_week:
-  flash:
-    <<: *flash
-    offset: ftd
-    difference: absolute
-    deviations: True
-  <<: *deuda_esp
-
-deuda_esp_ytd:
-  flash:
-    <<: *flash
-    offset: ytd
-    difference: absolute
-    deviations: False
-  <<: *deuda_esp
-
-.divisas: &divisas
-  sorted: True
-  series:
-    USD_OVER_RUB: Rublo
-    GBP=: Libra
-    EUR=: Euro*
-    USD_OVER_BRL: Real Brasileño
-    USD_OVER_CNY: Yuan
-    USD_OVER_TRY: Lira Turca
-    USD_OVER_JPY: Yen
-    USD_OVER_CHF: Franco Suizo
-  format:
-    <<: *perc_format
-    decimals: 0
-  annot_format:
-    <<: *perc_format
-    decimals: 1
-
-divisas_week:
-  flash:
-    <<: *flash
-    offset: ftd
-    difference: relative
-    deviations: True
-  <<: *divisas
-  format:
-    <<: *perc_format
-    decimals: 1
-  annot_format:
-    <<: *perc_format
-    decimals: 2
-
-
-
-divisas_ytd:
-  flash:
-    <<: *flash
-    offset: ytd
-    difference: relative
-    deviations: False
-  <<: *divisas

tesorotools_python-0.0.8/examples/data.yaml

@@ -1,4 +0,0 @@
-debug:
-  id1: alias1
-  id2: alias2
-  id3: alias3