tesorotools-python 0.0.9__py2.py3-none-any.whl → 0.0.11__py2.py3-none-any.whl

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/artists/line_plot.py

@@ -1,10 +1,14 @@
+import datetime
 import locale
 from pathlib import Path
-from typing import Any
+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, "")
 
@@ -112,3 +116,128 @@ def plot_line_charts(data: pd.DataFrame, config_dicts: dict[str, Any]):
         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/render/__init__.py

@@ -1,6 +1,7 @@
 from tesorotools.render.content.images import Image, Images
 from tesorotools.render.content.section import Section
 from tesorotools.render.content.table import Table
+from tesorotools.render.content.text import Text
 from tesorotools.render.report import Report
 from tesorotools.utils.template import TemplateLoader
 
@@ -9,3 +10,4 @@ TemplateLoader.add_constructor("!section", Section.from_yaml)
 TemplateLoader.add_constructor("!image", Image.from_yaml)
 TemplateLoader.add_constructor("!images", Images.from_yaml)
 TemplateLoader.add_constructor("!table", Table.from_yaml)
+TemplateLoader.add_constructor("!text", Text.from_yaml)

tesorotools/render/content/table.py

@@ -239,9 +239,9 @@ class Table:
 
     def __init__(
         self,
-        data_file: Path | None,
-        color_file: Path | None,
-        shade_file: Path | None,
+        data_file: Path | None = None,
+        color_file: Path | None = None,
+        shade_file: Path | None = None,
         block_sep: bool = False,
         title: str | None = None,
     ):
@@ -271,7 +271,12 @@ class Table:
         data_file: Path = root_path / f"{file_prefix}_data.feather"
         color_file: Path = root_path / f"{file_prefix}_color.feather"
         shade_file: Path = root_path / f"{file_prefix}_shade.feather"
-        return cls(data_file, color_file, shade_file, **table_cfg)
+        return cls(
+            data_file,
+            color_file=color_file if color_file.exists() else None,
+            shade_file=shade_file if shade_file.exists() else None,
+            **table_cfg,
+        )
 
     def render(self, document: Document) -> Document:
         document = render_table(

tesorotools/render/content/text.py

@@ -0,0 +1,23 @@
+from typing import Any, Self
+
+from docx.document import Document
+from yaml import Loader, MappingNode
+
+from tesorotools.render.content.content import Content
+
+
+class Text:
+    def __init__(self, text: str) -> None:
+        self._text = text
+
+    @classmethod
+    def from_yaml(cls, loader: Loader, node: MappingNode) -> Self:
+        values: dict[str, Any] = loader.construct_mapping(node, deep=True)
+        values.pop("id")
+        text: str = values.pop("text", None)
+        section: Self = cls(text=text)
+        return section
+
+    def render(self, document: Document) -> Document:
+        document.add_paragraph(self._text)
+        return document

{tesorotools_python-0.0.9.dist-info → tesorotools_python-0.0.11.dist-info}/METADATA

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

{tesorotools_python-0.0.9.dist-info → tesorotools_python-0.0.11.dist-info}/RECORD

@@ -1,9 +1,9 @@
-tesorotools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/__init__.py,sha256=rkjAQCbiNmcFq9qlYUZFEOhPGXd5ISqS2PSfu1V1khQ,311
 tesorotools/convert.py,sha256=qk4N-AZpKlmTD9L9SG0E43jqW27DJTHTu_Y1wehvETQ,3334
 tesorotools/main.py,sha256=ZxDyqBD_0zlfcdTZp84UPxlK3_O-9xfexDjLJVu4L5U,1357
 tesorotools/artists/__init__.py,sha256=exObsPqXdP6IaRn4QPkLRXUN67iOPNXtDgDAOoMxJoA,105
 tesorotools/artists/barh_plot.py,sha256=3KkoT0DLkctzYNMV3Pz1EcAT9i29YGYSkTLTFNb3dv8,9461
-tesorotools/artists/line_plot.py,sha256=BqOHnmVB6fL0ElN_WDpvCzP0L7O2-mp6ULfHo3qwiCI,3405
+tesorotools/artists/line_plot.py,sha256=TlQ5AFeQ5u4eNbjLkjJBH6ztKK8xAmccdVXqQiT4vpk,7553
 tesorotools/artists/table.py,sha256=CjyjWivn5YrNP5m8_eWi-ZA7R1ts3aIhATrYMEgTuOU,7651
 tesorotools/artists/type_curve.py,sha256=VGFCCyMVNwjliLK9usyw_nLC6emKcJYOSV1pmWJQNXk,6463
 tesorotools/assets/README.md,sha256=pB77vD_MvE26ftVNcZuj3iS0y-6g-WzqHb5OScDkQ3I,289
@@ -31,7 +31,7 @@ tesorotools/dependencies/resolution.py,sha256=Ctzzsm37YaJoyJQrbo9UcR0Sw6gw4xBnJO
 tesorotools/offsets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tesorotools/offsets/offsets.py,sha256=h8hEoQ6KEsANlMqbCmSImdymllsjFgrBseKcB9gyMLQ,14068
 tesorotools/offsets/outliers.py,sha256=37enrVwungs7KrNE7FYiPd-Eo3-5d9OHFeNXy6X7URo,415
-tesorotools/render/__init__.py,sha256=XiuKC7mwvsXMTpPcInPaVnVdv2BzWwM-dcVY8dXhkjA,575
+tesorotools/render/__init__.py,sha256=EN1aJcJq6O1AAxCAbpKuRvNBv8UVfUzzaHpNjGh929s,682
 tesorotools/render/headline.py,sha256=haKi1g2BvjrbLDMfsn6BaHJjGqPDmwlqH9e3pb9nzCE,1264
 tesorotools/render/introduction.py,sha256=uSeuOWiauLiX_hZYULFUiyw7JQwMHBIexr15-sW1ayA,1802
 tesorotools/render/report.py,sha256=rdbgeO1Ol6TM2mUkJeaAiJht_8Fcc9ZT5K_qbOXgj2Q,885
@@ -39,13 +39,14 @@ tesorotools/render/content/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJ
 tesorotools/render/content/content.py,sha256=m3USJXle5NctlQJs-d0tgSCvb-aNoCy2v7sZFqHZ1B8,409
 tesorotools/render/content/images.py,sha256=C0Tkrud17MqH_doenn5H-917kT6XCUdCmNek9CZkEXc,5040
 tesorotools/render/content/section.py,sha256=EugPBsb5mAWKRONAHQU-qCbKFQ419XU2vDJHQ0s_i3U,1682
-tesorotools/render/content/table.py,sha256=JjzmFI4CAENnSj8S0YX7-Y2HJtjZXZ6ERer3pa0Ju1c,9436
+tesorotools/render/content/table.py,sha256=zlnzDmDxnxAJQl3wF8mLXTX4ziTuG3d53PosQbR9lnE,9609
+tesorotools/render/content/text.py,sha256=g3VdYxXe1GHF1IjmFrHdfjgC9CzWWMwWmgHxifToIqM,678
 tesorotools/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tesorotools/utils/config.py,sha256=TMD_6OB2RS2sjM17tYwFnOtcXZgIxs-Ec8FYA3Qokuc,1056
 tesorotools/utils/globals.py,sha256=c5PBpZwpVO_nOetxyIk8j32Vx3GFlsgdYbwwfSSlv1M,374
 tesorotools/utils/matplotlib.py,sha256=tKidZIcDLKWgawIOJggWwVoaTMsrjw1WEJQouydSYbI,1197
 tesorotools/utils/series.py,sha256=eUEUOdzDfA7YbgO4o6KtxwJOL5cQYdqLjrdvuQ7Hqhc,1168
 tesorotools/utils/template.py,sha256=xpBVad28gG9ZLVwd9e0dTWsGsbujjmVcCPEW2mIKEJo,4917
-tesorotools_python-0.0.9.dist-info/METADATA,sha256=Ls3l-uHo06HBzNZ6GsfRZgEzJx1vvcyQdSdxnKDSrM4,323
-tesorotools_python-0.0.9.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-tesorotools_python-0.0.9.dist-info/RECORD,,
+tesorotools_python-0.0.11.dist-info/METADATA,sha256=qqF7kVms8kO2tV6B_TgJBpkjCthcqN-yvBL5v1oMSAQ,324
+tesorotools_python-0.0.11.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+tesorotools_python-0.0.11.dist-info/RECORD,,