excelipy 0.1.0__tar.gz

excelipy-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include excelipy *

excelipy-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: excelipy
+Version: 0.1.0
+Summary: Wrapper around xlsxwriter to improve usability
+Requires-Python: >=3.9.10
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: xlsxwriter>=3.2.2
+
+# Excelipy
+
+[![codecov](https://codecov.io/gh/choinhet/excelipy/graph/badge.svg?token=${CODECOV_TOKEN})](https://codecov.io/gh/choinhet/excelipy)

excelipy-0.1.0/README.md

@@ -0,0 +1,3 @@
+# Excelipy
+
+[![codecov](https://codecov.io/gh/choinhet/excelipy/graph/badge.svg?token=${CODECOV_TOKEN})](https://codecov.io/gh/choinhet/excelipy)

excelipy-0.1.0/excelipy/__init__.py

@@ -0,0 +1,22 @@
+__all__ = [
+    "Style",
+    "Component",
+    "Fill",
+    "Text",
+    "Table",
+    "Sheet",
+    "Excel",
+    "save",
+]
+
+from excelipy.models import (
+    Style,
+    Component,
+    Fill,
+    Text,
+    Table,
+    Sheet,
+    Excel,
+)
+
+from excelipy.service import save

excelipy-0.1.0/excelipy/const.py

@@ -0,0 +1,15 @@
+PROP_MAP = dict(
+    align="align",
+    valign="valign",
+    font_size="font_size",
+    font_color="font_color",
+    font_family="font_name",
+    bold="bold",
+    border="border",
+    border_left="left",
+    border_right="right",
+    border_top="top",
+    border_bottom="bottom",
+    border_color="border_color",
+    background="bg_color",
+)

excelipy-0.1.0/excelipy/main.py

@@ -0,0 +1,74 @@
+import logging
+from pathlib import Path
+
+import pandas as pd
+
+import excelipy as ep
+
+
+def main():
+    df = pd.DataFrame(
+        {
+            "testing": [1, 2, 3],
+            "tested": ["Yay", "Thanks", "Bud"],
+        }
+    )
+
+    sheets = [
+        ep.Sheet(
+            name="Hello!",
+            components=[
+                ep.Text(
+                    text="This is my table",
+                    style=ep.Style(bold=True),
+                    width=4,
+                ),
+                ep.Fill(
+                    width=4,
+                    style=ep.Style(background="#D0D0D0"),
+                ),
+                ep.Table(
+                    data=df,
+                    header_style=ep.Style(
+                        bold=True,
+                        border=5,
+                        border_color="#F02932",
+                    ),
+                    body_style=ep.Style(font_size=18),
+                    column_style={
+                        "testing": ep.Style(
+                            font_size=10,
+                            align="center",
+                        ),
+                    },
+                    column_width={
+                        "tested": 20,
+                    },
+                    row_style={
+                        1: ep.Style(
+                            border=2,
+                            border_color="#F02932",
+                        )
+                    },
+                    style=ep.Style(padding=1),
+                ).with_stripes(pattern="even"),
+            ],
+            style=ep.Style(
+                font_size=14,
+                font_family="Times New Roman",
+                padding=1,
+            ),
+        ),
+    ]
+
+    excel = ep.Excel(
+        path=Path("filename.xlsx"),
+        sheets=sheets,
+    )
+
+    ep.save(excel)
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.DEBUG)
+    main()

excelipy-0.1.0/excelipy/models.py

@@ -0,0 +1,123 @@
+from pathlib import Path
+from typing import Dict, Optional, Sequence, Literal
+
+import pandas as pd
+from pydantic import BaseModel, Field
+
+
+class Style(BaseModel):
+    class Config:
+        frozen = True
+
+    align: Optional[
+        Literal[
+            "left",
+            "center",
+            "right",
+            "fill",
+            "justify",
+            "center_across",
+            "distributed",
+        ]
+    ] = Field(default=None)
+    valign: Optional[
+        Literal[
+            "top",
+            "vcenter",
+            "bottom",
+            "vcenter",
+            "bottom",
+            "vjustify",
+        ]
+    ] = Field(default=None)
+    padding: Optional[int] = Field(default=None)
+    padding_left: Optional[int] = Field(default=None)
+    padding_right: Optional[int] = Field(default=None)
+    padding_top: Optional[int] = Field(default=None)
+    padding_bottom: Optional[int] = Field(default=None)
+    font_size: Optional[int] = Field(default=None)
+    font_color: Optional[str] = Field(default=None)
+    font_family: Optional[str] = Field(default=None)
+    bold: Optional[bool] = Field(default=None)
+    border: Optional[int] = Field(default=None)
+    border_left: Optional[int] = Field(default=None)
+    border_right: Optional[int] = Field(default=None)
+    border_top: Optional[int] = Field(default=None)
+    border_bottom: Optional[int] = Field(default=None)
+    border_color: Optional[str] = Field(default=None)
+    background: Optional[str] = Field(default=None)
+
+    def merge(self, other: "Style") -> "Style":
+        self_dict = self.model_dump(exclude_none=True)
+        other_dict = other.model_dump(exclude_none=True)
+        self_dict.update(other_dict)
+        return self.model_validate(self_dict)
+
+    def pl(self) -> int:
+        return self.padding_left or self.padding or 0
+
+    def pt(self) -> int:
+        return self.padding_top or self.padding or 0
+
+    def pr(self) -> int:
+        return self.padding_right or self.padding or 0
+
+    def pb(self) -> int:
+        return self.padding_bottom or self.padding or 0
+
+
+class Component(BaseModel):
+    style: Style = Field(default_factory=Style)
+
+    class Config:
+        arbitrary_types_allowed = True
+
+
+class Text(Component):
+    text: str
+    width: int = Field(default=1)
+    height: int = Field(default=1)
+
+
+class Fill(Component):
+    width: int = Field(default=1)
+    height: int = Field(default=1)
+
+
+class Table(Component):
+    data: pd.DataFrame
+    header_style: Style = Field(default_factory=Style)
+    body_style: Style = Field(default_factory=Style)
+    column_style: Dict[str, Style] = Field(default_factory=dict)
+    column_width: Dict[str, int] = Field(default_factory=dict)
+    row_style: Dict[int, Style] = Field(default_factory=dict)
+    max_col_width: Optional[int] = Field(default=None)
+    header_filters: bool = Field(default=True)
+
+    def with_stripes(
+        self,
+        color: str = "#D0D0D0",
+        pattern: Literal["even", "odd"] = "odd",
+    ) -> "Table":
+        return self.model_copy(
+            update=dict(
+                row_style={
+                    idx: self.row_style.get(idx, Style()).merge(Style(background=color))
+                    if (pattern == "odd" and idx % 2 != 0)
+                    or (pattern == "even" and idx % 2 == 0)
+                    else self.row_style.get(idx, Style())
+                    for idx in range(self.data.shape[0])
+                }
+            )
+        )
+
+
+class Sheet(BaseModel):
+    name: str
+    components: Sequence[Component] = Field(default_factory=list)
+    style: Style = Field(default_factory=Style)
+
+
+class Excel(BaseModel):
+    path: Path
+    sheets: Sequence[Sheet] = Field(default_factory=list)

excelipy-0.1.0/excelipy/service.py

@@ -0,0 +1,65 @@
+import logging
+from typing import Tuple
+
+import xlsxwriter
+from xlsxwriter.workbook import Workbook, Worksheet
+
+from excelipy.models import Component, Excel, Fill, Style, Table, Text
+from excelipy.writers import (
+    write_fill,
+    write_table,
+    write_text,
+)
+
+log = logging.getLogger("excelipy")
+
+
+def write_component(
+    workbook: Workbook,
+    worksheet: Worksheet,
+    component: Component,
+    default_style: Style,
+    origin: Tuple[int, int] = (0, 0),
+) -> Tuple[int, int]:
+    writing_map = {
+        Table: write_table,
+        Text: write_text,
+        Fill: write_fill,
+    }
+    render_func = writing_map.get(type(component))
+    if render_func is None:
+        return 0, 0
+    return render_func(
+        workbook,
+        worksheet,
+        component,
+        default_style,
+        origin,
+    )
+
+
+def save(excel: Excel):
+    workbook = xlsxwriter.Workbook(excel.path)
+    log.debug("Workbook opened")
+    for sheet in excel.sheets:
+        origin = (
+            sheet.style.pl(),
+            sheet.style.pt(),
+        )
+        worksheet = workbook.add_worksheet(sheet.name)
+        for component in sheet.components:
+            cur_origin = (
+                origin[0] + component.style.pl(),
+                origin[1] + component.style.pt(),
+            )
+            x, y = write_component(
+                workbook,
+                worksheet,
+                component,
+                sheet.style,
+                cur_origin,
+            )
+            origin = origin[0], origin[1] + y
+
+    workbook.close()
+    log.debug("Workbook closed")

excelipy-0.1.0/excelipy/style.py

@@ -0,0 +1,33 @@
+from typing import Dict, Sequence
+
+from xlsxwriter.workbook import Format, Workbook
+
+from excelipy.const import PROP_MAP
+from excelipy.models import Style
+
+cached_styles: Dict[Style, Format] = {}
+
+
+def _process_single(workbook: Workbook, style: Style) -> Format:
+    style_dict = style.model_dump(exclude_none=True)
+    style_map = {
+        mapped_prop: value
+        for property, value in style_dict.items()
+        if (mapped_prop := PROP_MAP.get(property)) is not None
+    }
+    format = workbook.add_format(style_map)
+    cached_styles[style] = format
+    return format
+
+
+def process_style(
+    workbook: Workbook,
+    styles: Sequence[Style],
+) -> Format:
+    cur_style = Style()
+    for style in styles:
+        cur_style = cur_style.merge(style)
+    if cur_style in cached_styles:
+        return cached_styles[cur_style]
+    format = _process_single(workbook, cur_style)
+    return format

excelipy-0.1.0/excelipy/writers/__init__.py

@@ -0,0 +1,9 @@
+__all__ = [
+    "write_table",
+    "write_fill",
+    "write_text",
+]
+
+from excelipy.writers.fill import write_fill
+from excelipy.writers.table import write_table
+from excelipy.writers.text import write_text

excelipy-0.1.0/excelipy/writers/fill.py

@@ -0,0 +1,34 @@
+import logging
+from typing import Tuple
+
+from xlsxwriter.workbook import Workbook, Worksheet
+
+from excelipy.models import Fill, Style
+from excelipy.style import process_style
+
+log = logging.getLogger("excelipy")
+
+
+def write_fill(
+    workbook: Workbook,
+    worksheet: Worksheet,
+    component: Fill,
+    default_style: Style,
+    origin: Tuple[int, int] = (0, 0),
+) -> Tuple[int, int]:
+    log.debug(f"Writing fill at {origin}")
+    worksheet.merge_range(
+        origin[1],
+        origin[0],
+        origin[1] + component.height - 1,
+        origin[0] + component.width - 1,
+        "",
+        process_style(
+            workbook,
+            [
+                default_style,
+                component.style,
+            ],
+        ),
+    )
+    return component.width, component.height

excelipy-0.1.0/excelipy/writers/table.py

@@ -0,0 +1,105 @@
+import logging
+from typing import Tuple
+
+from xlsxwriter.workbook import Workbook, Worksheet
+
+from excelipy.models import Style, Table
+from excelipy.style import process_style
+
+log = logging.getLogger("excelipy")
+
+DEFAULT_FONT_SIZE = 11
+SCALING_FACTOR = 1
+BASE_PADDING = 2
+
+
+def get_auto_width(
+    header: str,
+    component: Table,
+    default_style: Style,
+) -> int:
+    header_len = len(header)
+    col_len = component.data[header].apply(str).apply(len).max()
+    max_len = max(header_len, col_len)
+    max_font_size = max(
+        (
+            component.header_style.font_size
+            or default_style.font_size
+            or DEFAULT_FONT_SIZE
+        ),
+        (
+            component.column_style.get(header, Style()).font_size
+            or component.body_style.font_size
+            or default_style.font_size
+            or DEFAULT_FONT_SIZE
+        ),
+        (
+            max(
+                s.font_size
+                or component.body_style.font_size
+                or default_style.font_size
+                or DEFAULT_FONT_SIZE
+                for s in component.row_style.values()
+            )
+        ),
+    )
+    font_factor = max_font_size / DEFAULT_FONT_SIZE
+    return SCALING_FACTOR * font_factor * max_len + BASE_PADDING
+
+
+def write_table(
+    workbook: Workbook,
+    worksheet: Worksheet,
+    component: Table,
+    default_style: Style,
+    origin: Tuple[int, int] = (0, 0),
+) -> Tuple[int, int]:
+    x_size = component.data.shape[1]
+    y_size = component.data.shape[0]
+
+    header_format = process_style(workbook, [default_style, component.header_style])
+    for col_idx, header in enumerate(component.data.columns):
+        worksheet.write(
+            origin[1],
+            origin[0] + col_idx,
+            header,
+            header_format,
+        )
+        set_width = component.column_width.get(header)
+        if set_width:
+            estimated_width = set_width
+        else:
+            estimated_width = get_auto_width(header, component, default_style)
+        worksheet.set_column(origin[1], origin[0] + col_idx, int(estimated_width))
+
+    if component.header_filters:
+        worksheet.autofilter(
+            origin[1],
+            origin[0],
+            origin[1],
+            origin[0] + len(list(component.data.columns)) - 1,
+        )
+
+    for col_idx, col in enumerate(component.data.columns):
+        col_style = component.column_style.get(col)
+        for row_idx, (_, row) in enumerate(component.data.iterrows()):
+            row_style = component.row_style.get(row_idx)
+            non_none = filter(
+                None,
+                [
+                    default_style,
+                    component.body_style,
+                    col_style,
+                    row_style,
+                ],
+            )
+            current_format = process_style(workbook, list(non_none))
+            cell = row[col]
+            worksheet.write(
+                origin[1] + row_idx + 1,
+                origin[0] + col_idx,
+                cell,
+                current_format,
+            )
+
+    return x_size, y_size

excelipy-0.1.0/excelipy/writers/text.py

@@ -0,0 +1,41 @@
+import logging
+from typing import Tuple
+
+from xlsxwriter.workbook import Workbook, Worksheet
+
+from excelipy.models import Style, Text
+from excelipy.style import process_style
+
+log = logging.getLogger("excelipy")
+
+
+def write_text(
+    workbook: Workbook,
+    worksheet: Worksheet,
+    component: Text,
+    default_style: Style,
+    origin: Tuple[int, int] = (0, 0),
+) -> Tuple[int, int]:
+    log.debug(f"Writing text at {origin}")
+
+    worksheet.merge_range(
+        origin[1],
+        origin[0],
+        origin[1] + component.height - 1,
+        origin[0] + component.width - 1,
+        "",
+    )
+
+    worksheet.write(
+        origin[1],
+        origin[0],
+        component.text,
+        process_style(
+            workbook,
+            [
+                default_style,
+                component.style,
+            ],
+        ),
+    )
+    return component.width, component.height

excelipy-0.1.0/excelipy.egg-info/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: excelipy
+Version: 0.1.0
+Summary: Wrapper around xlsxwriter to improve usability
+Requires-Python: >=3.9.10
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: xlsxwriter>=3.2.2
+
+# Excelipy
+
+[![codecov](https://codecov.io/gh/choinhet/excelipy/graph/badge.svg?token=${CODECOV_TOKEN})](https://codecov.io/gh/choinhet/excelipy)

excelipy-0.1.0/excelipy.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+MANIFEST.in
+README.md
+pyproject.toml
+excelipy/__init__.py
+excelipy/const.py
+excelipy/main.py
+excelipy/models.py
+excelipy/service.py
+excelipy/style.py
+excelipy.egg-info/PKG-INFO
+excelipy.egg-info/SOURCES.txt
+excelipy.egg-info/dependency_links.txt
+excelipy.egg-info/requires.txt
+excelipy.egg-info/top_level.txt
+excelipy/writers/__init__.py
+excelipy/writers/fill.py
+excelipy/writers/table.py
+excelipy/writers/text.py
+test/test_load.py

excelipy-0.1.0/excelipy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

excelipy-0.1.0/excelipy.egg-info/requires.txt

@@ -0,0 +1,3 @@
+pandas>=2.2.3
+pydantic>=2.11.3
+xlsxwriter>=3.2.2

excelipy-0.1.0/excelipy.egg-info/top_level.txt

@@ -0,0 +1 @@
+excelipy

excelipy-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "excelipy"
+version = "0.1.0"
+description = "Wrapper around xlsxwriter to improve usability"
+readme = "README.md"
+requires-python = ">=3.9.10"
+
+dependencies = ["pandas>=2.2.3", "pydantic>=2.11.3", "xlsxwriter>=3.2.2"]
+
+[tool.uv]
+dev-dependencies = [
+    "pytest>=8.3.3",
+    "pytest-cov>=4.1.0",
+    "coverage>=7.6.1",
+    "pytest-mock>=3.14.0",
+    "pytest-asyncio>=0.25.3",
+    "debugpy>=1.8.13",
+    "pyright>=1.1.398",
+]
+
+[tool.setuptools]
+packages = ["excelipy"]

excelipy-0.1.0/setup.cfg

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

excelipy-0.1.0/test/test_load.py

@@ -0,0 +1,2 @@
+def test_load():
+    assert True