rephorm 1.0.1__tar.gz

rephorm-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 OGResearch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rephorm-1.0.1/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: rephorm
+Version: 1.0.1
+Summary: Python package for generating PDF reports through code
+Author-email: OGResearch <it@ogresearch.com>
+Maintainer-email: Sergey Plotnikov <sergey.plotnikov@ogresearch.com>, Ngoc Nam Nguyen <nam.nguyen@ogresearch.com>, Martynas Vycas <martynas.vycas@ogresearch.com>
+License: MIT License
+        
+        Copyright (c) 2025 OGResearch
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+License-File: LICENSE
+Requires-Dist: irispie>=0.61.0
+Requires-Dist: fpdf2>=2.7.9
+Requires-Dist: PyMuPDF>=1.25.1
+Requires-Dist: twine==6.1.0
+Requires-Dist: pkginfo>=1.12.1.2
+Requires-Dist: kaleido==0.1.0post1; platform_system == "Windows"
+Requires-Dist: kaleido==0.2.1; platform_system != "Windows"
+Dynamic: license-file

rephorm-1.0.1/README.md

@@ -0,0 +1,5 @@
+Rephorm is a Python package for generating PDF reports through code. It builds on the capabilities of fpdf2 for PDF 
+rendering and IRISPIE for seamless integration of economic models and data.
+
+Rephorm provides a modular framework of configurable objects that can be instantiated, customized, and composed to 
+create structured PDF reports.

rephorm-1.0.1/pyproject.toml

@@ -0,0 +1,60 @@
+[bumpver]
+current_version = "1.0.1"
+version_pattern = "MAJOR.MINOR.PATCH[.TAGNUM]"
+tag_regex = "^{version}$"
+
+[bumpver.file_patterns]
+"pyproject.toml" = [
+    'version = "{version}"'
+]
+"src/rephorm/__init__.py" = [
+    '__version__ = "{version}"'
+]
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rephorm"
+version = "1.0.1"
+description = "Python package for generating PDF reports through code"
+authors = [
+    { name = "OGResearch", email = "it@ogresearch.com" }
+]
+maintainers = [
+    { name = "Sergey Plotnikov", email = "sergey.plotnikov@ogresearch.com" },
+    { name = "Ngoc Nam Nguyen", email = "nam.nguyen@ogresearch.com" },
+    { name = "Martynas Vycas", email = "martynas.vycas@ogresearch.com" },
+]
+license = { file = "LICENSE" }
+#readme = "README.md"  # Optional: if you want to include a README
+requires-python = ">=3.12"
+dependencies = [
+    "irispie >= 0.61.0",
+    "fpdf2 >= 2.7.9",
+    "PyMuPDF >= 1.25.1",
+    "twine == 6.1.0",
+    "pkginfo >= 1.12.1.2",
+    'kaleido == 0.1.0post1; platform_system == "Windows"',
+    'kaleido == 0.2.1; platform_system != "Windows"'
+]
+
+classifiers = [
+    "Intended Audience :: Financial and Insurance Industry",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"rephorm.utility.fonts" = ["*.ttf"]
+
+[tool.setuptools.dynamic]
+version = { attr = "rephorm.__version__" }

rephorm-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

rephorm-1.0.1/src/rephorm/__init__.py

@@ -0,0 +1,19 @@
+# from .report import *
+from rephorm.objects.report import Report
+from rephorm.objects.table_section import TableSection
+from rephorm.objects.table import Table
+from rephorm.objects.page_break import PageBreak
+from rephorm.objects.grid import Grid
+from rephorm.objects.chart import Chart
+from rephorm.objects.chapter import Chapter
+from .objects.text import Text
+from rephorm.objects.footnote import Footnote
+from rephorm.objects.chart_series import ChartSeries
+from rephorm.objects.table_series import TableSeries
+
+__version__ = "1.0.1"
+__author__ = 'OGResearch team'
+__credits__ = 'OGResearch'
+__license__ = 'Copyright 2025 OGResearch, all rights reserved'
+
+

rephorm-1.0.1/src/rephorm/decorators/settings_validation.py

@@ -0,0 +1,49 @@
+import inspect
+
+from rephorm.object_params.settings import object_params
+
+def validate_kwargs(func):
+    """
+    A decorator that validates kwargs (keys and values).
+    It uses ultimate_setting_owner dict!
+    """
+    def wrapper(*args, **kwargs):
+        module_name = func.__module__.split('.')[-1].upper()
+
+        signature = inspect.signature(func)
+        excluded_keys = set(signature.parameters.keys())
+
+        for key, value in kwargs.items():
+
+            # Skip validation for object args/params (We want to validate only kwargs)
+            if key in excluded_keys and key not in object_params:
+                continue
+
+            # Validate key | If the key is within object_params (allowed keys)
+            if key not in object_params:
+                raise KeyError(f"{module_name}: Invalid key '{key}'. "
+                               f"Allowed keys are: {list(object_params.keys())}")
+
+            # Get the expected type from ultimate_setting_owner
+            expected_type = object_params[key]["type"]
+            object_params_key = object_params[key]
+
+            # Validate value type
+            # to skip type-checking for complex types
+            if expected_type is None:
+                continue
+            if not isinstance(value, expected_type):
+                raise TypeError(
+                    f"{module_name}: Argument '{key}' must be of type {expected_type.__name__}, "
+                    f"got {type(value).__name__} instead."
+                )
+
+            # Validate possible values | if they are defined within the object_params
+            if "possible_values" in object_params_key and value not in object_params_key["possible_values"]:
+                possible_values = object_params_key["possible_values"]
+                raise ValueError(
+                    f"{module_name}: Argument '{key}' has invalid value '{value}'. Allowed values are: {possible_values}")
+
+        return func(*args, **kwargs)
+
+    return wrapper

rephorm-1.0.1/src/rephorm/dict/__init__.py

@@ -0,0 +1 @@
+#

rephorm-1.0.1/src/rephorm/dict/colors.py

@@ -0,0 +1,22 @@
+# Matlab default colors: https://nl.mathworks.com/help/matlab/creating_plots/specify-plot-colors.html
+# Keep codes in hex format here, because FontFace do not accept rgb or rgba, (and we use it for text)
+# for charts and plotly we do conversion to rgba in resolve_highlight_color
+
+color_codes = {
+    "red": "#FF0000",
+    "r": "#FF0000",
+    "green": "#00FF00",
+    "g": "#00FF00",
+    "blue": "#0000FF",
+    "b": "#0000FF",
+    "cyan": "#00FFFF",
+    "c": "#00FFFF",
+    "magenta": "#FF00FF",
+    "m": "#FF00FF",
+    "yellow": "#FFFF00",
+    "y": "#FFFF00",
+    "black": "#000000",
+    "k": "#000000",
+    "white": "#FFFFFF",
+    "w": "#FFFFFF"
+}

rephorm-1.0.1/src/rephorm/dict/legend_positions.py

@@ -0,0 +1,136 @@
+legend_positions = {
+    # Center positions
+    "C": {  # Center (Inline)
+        "x": 0.5,
+        "y": 0.5,
+        "xanchor": "center",
+        "yanchor": "middle",
+        "yref": "paper"
+    },
+    # Inside positions
+    "N": {  # North (Top-Center)
+        "x": 0.5,
+        "y": 1,
+        "xanchor": "center",
+        "yanchor": "top",
+        "yref": "paper"
+    },
+    "S": {  # South (Bottom-Center)
+        "x": 0.5,
+        "y": 0,
+        "xanchor": "center",
+        "yanchor": "bottom",
+        "yref": "paper"
+    },
+    "E": {  # East (Right-Center)
+        "x": 1,
+        "y": 0.5,
+        "xanchor": "right",
+        "yanchor": "middle",
+        "yref": "paper"
+    },
+    "W": {  # West (Left-Center)
+        "x": 0,
+        "y": 0.5,
+        "xanchor": "left",
+        "yanchor": "middle",
+        "yref": "paper"
+    },
+    "NE": {  # North-East (Top-Right)
+        "x": 1,
+        "y": 1,
+        "xanchor": "right",
+        "yanchor": "top",
+        "yref": "paper"
+    },
+    "NW": {  # North-West (Top-Left)
+        "x": 0,
+        "y": 1,
+        "xanchor": "left",
+        "yanchor": "top",
+        "yref": "paper"
+    },
+    "SE": {  # South-East (Bottom-Right)
+        "x": 1,
+        "y": 0,
+        "xanchor": "right",
+        "yanchor": "bottom",
+        "yref": "paper"
+    },
+    "SW": {  # South-West (Bottom-Left)
+        "x": 0,
+        "y": 0,
+        "xanchor": "left",
+        "yanchor": "bottom",
+        "yref": "paper"
+    },
+
+    # Outside positions
+    "NO": {  # North-Outside (Above Top-Center)
+        "x": 0.5,
+        "y": 0.89,
+        "xanchor": "center",
+        "yanchor": "top",
+        "yref": "container"
+    },
+    "SO": {  # South-Outside (Below Bottom-Center)
+        "x": 0.5,
+        # "y": 0,
+        "xanchor": "center",
+        # "yanchor": "bottom",
+        # "yref": "container"
+    },
+    # South-Outside (ADJUSTED) Need proper testing
+    # TODO: Consider changing back to "paper" and off-setting POS using negatives.
+    # "SO": {
+    #     "x": 0.5,
+    #     "y": -0.15,
+    #     "xanchor": "center",
+    #     "yanchor": "top",
+    #     "yref": "paper"
+    # },
+    "EO": {  # East-Outside (Right of Chart)
+        "x": 0.8,
+        "y": 0.5,
+        "xanchor": "left",
+        "yanchor": "middle",
+        "yref": "container",
+        "xref": "container"
+    },
+    "WO": {  # West-Outside (Left of Chart)
+        "x": 0,
+        "y": 0.5,
+        "xanchor": "left",
+        "yanchor": "middle",
+        "yref": "container",
+        "xref": "container"
+    },
+    "NEO": {  # North-East-Outside (Above Top-Right)
+        "x": 1,
+        "y": -0.1,
+        "xanchor": "right",
+        "yanchor": "top",
+        "yref": "container"
+    },
+    "NWO": {  # North-West-Outside (Above Top-Left)
+        "x": 0,
+        "y": -0.1,
+        "xanchor": "left",
+        "yanchor": "top",
+        "yref": "container"
+    },
+    "SEO": {
+    "x": 1,
+    "y": 0,
+    "xanchor": "right",
+    "yanchor": "bottom",
+    "yref": "container",
+    },
+    "SWO": {  # South-West-Outside (Below Bottom-Left)
+        "x": 0,
+        "y": 0,
+        "xanchor": "left",
+        "yanchor": "bottom",
+        "yref": "container"
+    }
+}

rephorm-1.0.1/src/rephorm/dict/styles.py

@@ -0,0 +1,206 @@
+DEFAULT_FONT_FAMILY = "Helvetica" # This was agreed upon
+
+def default_styles(font_family=DEFAULT_FONT_FAMILY):
+    return {
+        "table": {
+            "highlight_color": "#E0E0E0",
+            "title": {
+                "font_style": "B",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 13,
+            },
+            "heading": {
+                "font_style": "",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 10,
+                "highlight_color": "#E0E0E0",
+            },
+            "series": {
+                "font_style": "",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 10,
+                "highlight_color": "#E0E0E0",
+            },
+            "section": {
+                "font_style": "",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 10,
+                "highlight_color": "#E0E0E0",
+            }
+        },
+        "text": {
+            "font_style": "",
+            "font_family": font_family,
+            "font_size": 10,
+            "title": {
+                "font_style": "B",
+                "font_family": font_family,
+                "font_size": 16,
+            }
+        },
+        "footnotes": {
+            "font_size": 8,
+            "font_color": "#000000",
+            "font_style": "",
+            "font_family": font_family,
+        },
+        "grid": {
+            "title": {
+                "font_style": "B",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 13,
+            },
+        },
+        "chapter": {
+            "title": {
+                "font_style": "B",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 16,
+            },
+            "font_style": "",
+            "font_family": font_family,
+            "font_size": 11,
+        },
+        "chart": {
+            "highlight_color": "rgba(0, 0, 0, 0.12)",
+            "grid_color": "lightgrey",
+            "bg_color": "rgba(0, 255, 0, 0)",
+            "chart_border_color": "#000000",
+            "line_styles_order": [
+                "solid"
+            ],
+            "line_color_order": [
+                "rgb(31, 119, 180)",
+                "rgb(255, 127, 14)",
+                "rgb(44, 160, 44)",
+                "rgb(214, 39, 40)",
+                "rgb(148, 103, 189)",
+                "rgb(140, 86, 75)",
+                "rgb(227, 119, 194)",
+                "rgb(127, 127, 127)",
+                "rgb(188, 189, 34)",
+                "rgb(23, 190, 207)"
+            ],
+            "bar_color_order": [
+                "rgb(31, 119, 180)",
+                "rgb(255, 127, 14)",
+                "rgb(44, 160, 44)",
+                "rgb(214, 39, 40)",
+                "rgb(148, 103, 189)",
+                "rgb(140, 86, 75)",
+                "rgb(227, 119, 194)",
+                "rgb(127, 127, 127)",
+                "rgb(188, 189, 34)",
+                "rgb(23, 190, 207)"
+            ],
+            "line_width_order": [1],
+            "series": {
+                "bar_edge_color": "black",
+                "bar_face_color": None,
+                "bar_edge_width": 1.0,
+                "line_width": None,
+                "line_style": None,
+                "line_color": None,
+                "marker_color": "#46b336",
+                "marker_size": 1,
+                "marker_width": 1,
+            },
+            "legend": {
+                "border_width": 0,
+                "bg_color": "rgba(255, 255, 255, 0)",
+                "font_style": "",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 8,
+            },
+            "title": {
+                "font_style": "",
+                "font_family": font_family,
+                "font_color": "#000000",
+                "font_size": 11,
+            },
+            "x_axis": {
+                "ticks": {
+                    "font_size": 10,
+                    "font_color": "#000000",
+                    "font_family": font_family,
+                },
+                "label": {
+                    "font_size": 10,
+                    "font_color": "#000000",
+                    "font_family": font_family,
+                }
+            },
+            "y_axis": {
+                "ticks": {
+                    "font_size": 10,
+                    "font_color": "#000000",
+                    "font_family": font_family,
+                },
+                "label": {
+                    "font_size": 10,
+                    "font_color": "#000000",
+                    "font_family": font_family,
+                },
+            },
+            "y_axis2": {
+                "ticks": {
+                    "font_size": 10,
+                    "font_color": "#000000",
+                    "font_family": font_family,
+
+                },
+                "label": {
+                    "font_size": 10,
+                    "font_color": "#000000",
+                    "font_family": font_family,
+                }
+            },
+        },
+        "report": {
+            # only front page title
+            "title": {
+                "font_style": "B",
+                "font_size": 25,
+                "font_color": "#000000",
+                "font_family": font_family,
+            },
+            "subtitle": {
+                "font_style": "B",
+                "font_size": 21,
+                "font_color": "#000000",
+                "font_family": font_family,
+            },
+            "abstract": {
+                "height": 50,
+                "font_size": 10,
+                "font_color": "#000000",
+                "font_family": font_family,
+            },
+            "footer": {
+                "height": 15,
+                "top_margin": 5,
+                "top_padding": 5,
+            },
+            "header": {
+                "height": 20,
+                "bottom_margin": 5,
+            },
+            "font_style": "",
+            "font_family": font_family,
+            "font_color": "#000000",
+            "page_margin_top": 10,
+            "page_margin_right": 40,
+            "page_margin_bottom": 15,
+            "page_margin_left": 40,
+            #Todo: Find a better name for it.
+            "title_bottom_padding": 10,
+            "logo_height": 15,
+        }
+    }