tesorotools-python 0.0.0__tar.gz

tesorotools_python-0.0.0/.gitignore

@@ -0,0 +1,20 @@
+.venv/
+.build1/
+
+__pycache__
+
+data/
+assets/
+config/
+debug/
+tablas/
+
+dist/
+
+*.png
+*.feather
+*.csv
+*.docx
+*.docx#
+
+test/

tesorotools_python-0.0.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: tesorotools-python
+Version: 0.0.0
+Requires-Dist: babel
+Requires-Dist: eikon
+Requires-Dist: matplotlib
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: psycopg2
+Requires-Dist: pyarrow
+Requires-Dist: python-docx
+Requires-Dist: pyyaml
+Requires-Dist: sqlalchemy

tesorotools_python-0.0.0/README.md

@@ -0,0 +1,83 @@
+# 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.
+
+## Sistema de lectura de archivos `.yaml`
+El informe a generar se describe mediante unas *plantillas*, que en la práctica son archivos `.yaml`, con lo que es importante entender cómo el programa procede a la lectura de los mismos.
+
+Todo archivo `.yaml` debe leerse a través de la función `utils.config.read_config`. Esta toma como parámetros el path al fichero a leer y un *cargador*. Siempre que se vaya a leer una *plantilla*, este cargador debe ser `utils.config.CustomLoader`, en caso contrario, puede dejarse en blanco.
+
+En el proceso de lectura, el documento completo se representa como un objeto de tipo `MappingNode` y este es el parámetro `node` en la función `construct_mapping`.
+
+Cada `MappingNode` contiene un atributo `value`, que en una lista de tuplas `(key_node, value_node)`
+
+Dentro de un documento `.yaml` sencillo como
+```yaml
+clave1: "valor1"
+```
+
+La lista `value` solo tiene una tupla en su interior, donde:
+- La clave o `key_node` es de tipo `ScalarNode` con tag `tag:yaml.org,2002:str` *implícito* y valor `clave1`.
+- El valor o `value_node` también es de tipo `ScalarNode` con valor `valor1`.
+
+En casos más complejos como
+```yaml
+clave2: !offset_table
+  subclave: "subvalor"
+``` 
+
+De nuevo, la lista `value` solo contendrá una tupla en su interior, donde:
+- La clave es un `ScalarNode` con valor `clave2`
+- El valor es un `MappingNode` con *tag* personalizado `!offset_table`. Su valor a su vez en una lista de tuplas bla bla bla (se ve la recursividad)
+
+## 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.0/examples/README.md

@@ -0,0 +1,24 @@
+## 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.0/examples/barh_plots.yaml

@@ -0,0 +1,202 @@
+.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.0/examples/data.yaml

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

tesorotools_python-0.0.0/examples/dependencies.yaml

@@ -0,0 +1,162 @@
+# keep dependent series in a separate file to avoid cluttering
+# a series at time t can only depend on other series on time t 
+
+# diferenciales
+
+PT10YT=RR_DIFF:
+  dependencies:
+    - PT10YT=RR
+    - DE10YT=RR
+  function: difference
+
+GR10YT=RR_DIFF:
+  dependencies:
+    - GR10YT=RR
+    - DE10YT=RR
+  function: difference
+
+EUUNIEURAE10Y=_DIFF:
+  dependencies:
+    - EUUNIEURAE10Y=
+    - DE10YT=RR
+  function: difference
+
+IT10YT=RR_DIFF:
+  dependencies:
+    - IT10YT=RR
+    - DE10YT=RR
+  function: difference
+
+FR10YT=RR_DIFF:
+  dependencies:
+    - FR10YT=RR
+    - DE10YT=RR
+  function: difference
+
+ES3MT=RR_DIFF:
+  dependencies:
+    - ES3MT=RR
+    - DE3MT=RR
+  function: difference
+
+ES6MT=RR_DIFF:
+  dependencies:
+    - ES6MT=RR
+    - DE6MT=RR
+  function: difference
+
+ES1YT=RR_DIFF:
+  dependencies:
+    - ES1YT=RR
+    - DE1YT=RR
+  function: difference
+
+ES2YT=RR_DIFF:
+  dependencies:
+    - ES2YT=RR
+    - DE2YT=RR
+  function: difference
+
+ES3YT=RR_DIFF:
+  dependencies:
+    - ES3YT=RR
+    - DE3YT=RR
+  function: difference
+
+ES4YT=RR_DIFF:
+  dependencies:
+    - ES4YT=RR
+    - DE4YT=RR
+  function: difference
+
+ES5YT=RR_DIFF:
+  dependencies:
+    - ES5YT=RR
+    - DE5YT=RR
+  function: difference
+
+ES6YT=RR_DIFF:
+  dependencies:
+    - ES6YT=RR
+    - DE6YT=RR
+  function: difference
+
+ES7YT=RR_DIFF:
+  dependencies:
+    - ES7YT=RR
+    - DE7YT=RR
+  function: difference
+
+ES8YT=RR_DIFF:
+  dependencies:
+    - ES8YT=RR
+    - DE8YT=RR
+  function: difference
+
+ES9YT=RR_DIFF:
+  dependencies:
+    - ES9YT=RR
+    - DE9YT=RR
+  function: difference
+
+ES10YT=RR_DIFF:
+  dependencies:
+    - ES10YT=RR
+    - DE10YT=RR
+  function: difference
+
+ES15YT=RR_DIFF:
+  dependencies:
+    - ES15YT=RR
+    - DE15YT=RR
+  function: difference
+
+ES20YT=RR_DIFF:
+  dependencies:
+    - ES20YT=RR
+    - DE20YT=RR
+  function: difference
+
+ES25YT=RR_DIFF:
+  dependencies:
+    - ES25YT=RR
+    - DE25YT=RR
+  function: difference
+
+ES30YT=RR_DIFF:
+  dependencies:
+    - ES30YT=RR
+    - DE30YT=RR
+  function: difference
+
+# divisas
+
+USD_OVER_JPY:
+  dependencies:
+    - JPY=
+  function: inverse
+
+USD_OVER_CNY:
+  dependencies:
+    - CNY=
+  function: inverse
+
+USD_OVER_CHF:
+  dependencies:
+    - CHF=
+  function: inverse
+
+USD_OVER_RUB:
+  dependencies:
+    - RUB=
+  function: inverse
+
+USD_OVER_BRL:
+  dependencies:
+    - BRL=
+  function: inverse
+
+USD_OVER_TRY:
+  dependencies:
+    - TRY=
+  function: inverse

tesorotools_python-0.0.0/examples/line_plots.yaml

@@ -0,0 +1,57 @@
+.b100_format: &b100_format
+  units: ""
+  decimals: 0
+
+.perc_format: &perc_format
+  units: "%"
+  decimals: 2
+
+.pb_format: &pb_format
+  units: "p.b."
+  decimals: 0
+
+# for the moment only support for fixed dates
+diferenciales:
+  base_100: False
+  start_date: 2024-01-01
+  end_date:
+  annotate: True
+  format:
+    <<: *pb_format
+  series:
+    ES10YT=RR_DIFF: España
+    GR10YT=RR_DIFF: Grecia
+    PT10YT=RR_DIFF: Portugal
+    FR10YT=RR_DIFF: Francia
+    IT10YT=RR_DIFF: Italia
+
+divisas:
+  base_100: True
+  start_date: 2024-11-01
+  end_date: 
+  annotate: False
+  format:
+    <<: *b100_format
+  series:
+    EUR=: Euro
+    GBP=: Libra
+    USD_OVER_JPY: Yen
+    USD_OVER_CNY: Yuan
+    USD_OVER_CHF: Franco Suizo
+
+tipos:
+  base_100: True
+  start_date: 2024-11-01
+  end_date: 
+  annotate: False
+  format:
+    <<: *b100_format
+  series:
+    ES10YT=RR: España
+    GR10YT=RR: Grecia
+    PT10YT=RR: Portugal
+    FR10YT=RR: Francia
+    IT10YT=RR: Italia
+    DE10YT=RR: Alemania
+  legend:
+    ncol: 3

tesorotools_python-0.0.0/examples/offsets.yaml

@@ -0,0 +1,17 @@
+# same window for every stat function
+window: 7300
+
+stats:
+  - roll_avg
+  - roll_std
+
+differences:
+  - absolute
+  - relative
+
+offsets:
+  - bday
+  - ftd
+  - mtd
+  - ytd
+  - 2025-04-02

tesorotools_python-0.0.0/examples/plots.yaml

@@ -0,0 +1,43 @@
+# general plot config file
+
+style:
+  font: Cabinet Grotesk
+
+figure:
+  dpi: 500
+  layout: constrained
+
+ax:
+  spines:
+    color: gray
+    linewidth: 1
+  baseline:
+    color: "#d9e1fc"
+    linestyle: solid
+    linewidth: 1
+    zorder: 1
+
+type_curve:
+  last:
+    alpha: 0.2
+    color: C1
+  current:
+    alpha: 0.3
+    color: C0
+  line:
+    linewidth: 2
+    marker: D
+    color: C0
+  legend_sep: -0.1
+
+barh:
+  highlight_factor: 0.4
+  padding: 5
+
+line:
+  legend_sep: -0.125
+  ncol: 5
+
+table:
+  style: Light Shading Accent 1
+  autofit: False