compareexcel 0.2.1__py3-none-any.whl

compareexcel/__init__.py

@@ -0,0 +1,20 @@
+"""Compare Excel workbooks for formatting and alignment differences."""
+
+from compareexcel.core import (
+    compare_data_alignment,
+    compare_formatting,
+    compare_header_alignment,
+    get_column_formats,
+)
+from compareexcel.report import write_report
+
+__version__ = "0.2.0"
+
+__all__ = [
+    "__version__",
+    "compare_data_alignment",
+    "compare_formatting",
+    "compare_header_alignment",
+    "get_column_formats",
+    "write_report",
+]

compareexcel/cli.py

@@ -0,0 +1,81 @@
+"""Command-line interface for comparing two Excel files."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+from openpyxl import load_workbook
+
+from compareexcel.core import (
+    compare_data_alignment,
+    compare_formatting,
+    compare_header_alignment,
+)
+from compareexcel.report import write_report
+
+
+def _ensure_utf8_stdio():
+    for stream in (sys.stdout, sys.stderr):
+        if hasattr(stream, "reconfigure"):
+            try:
+                stream.reconfigure(encoding="utf-8", errors="replace")
+            except Exception:
+                pass
+
+
+def main():
+    _ensure_utf8_stdio()
+
+    parser = argparse.ArgumentParser(
+        description="Compare two Excel workbooks for formatting and alignment differences.",
+    )
+    parser.add_argument("file1")
+    parser.add_argument("file2")
+    parser.add_argument("--sheet")
+    parser.add_argument("--alignment-only", "--ao", action="store_true")
+    parser.add_argument("--output", help="Output Excel report file")
+
+    args = parser.parse_args()
+
+    wb1 = load_workbook(args.file1)
+    wb2 = load_workbook(args.file2)
+
+    sheets = [args.sheet] if args.sheet else set(wb1.sheetnames) & set(wb2.sheetnames)
+
+    all_format_diffs = []
+    all_data_align_diffs = []
+    all_header_align_diffs = []
+
+    for sheet in sheets:
+        ws1 = wb1[sheet]
+        ws2 = wb2[sheet]
+
+        fmt = compare_formatting(ws1, ws2)
+        da = compare_data_alignment(ws1, ws2)
+        ha = compare_header_alignment(ws1, ws2)
+
+        for row in fmt:
+            row["Sheet"] = sheet
+        for row in da:
+            row["Sheet"] = sheet
+        for row in ha:
+            row["Sheet"] = sheet
+
+        all_format_diffs.extend(fmt)
+        all_data_align_diffs.extend(da)
+        all_header_align_diffs.extend(ha)
+
+    print("\n=== SUMMARY ===")
+    print(f"Formatting diffs: {len(all_format_diffs)}")
+    print(f"Data alignment diffs: {len(all_data_align_diffs)}")
+    print(f"Header alignment diffs: {len(all_header_align_diffs)}")
+
+    if args.output:
+        write_report(
+            args.output,
+            all_format_diffs,
+            all_data_align_diffs,
+            all_header_align_diffs,
+        )
+        print(f"\nReport written to: {args.output}")

compareexcel/core.py

@@ -0,0 +1,150 @@
+"""Worksheet comparison: headers, number formats, and cell alignment."""
+
+from __future__ import annotations
+
+
+def _header_to_column_map(ws):
+    header_cells = list(ws.iter_rows(min_row=1, max_row=1))[0]
+    return {
+        str(c.value).strip(): c.column
+        for c in header_cells if c.value
+    }
+
+
+def _alignment_tuple(cell):
+    if cell is None or cell.alignment is None:
+        return ("general", "bottom", 0, False, False, 0)
+
+    al = cell.alignment
+    return (
+        al.horizontal or "general",
+        al.vertical or "bottom",
+        al.text_rotation or 0,
+        bool(al.wrap_text),
+        bool(al.shrink_to_fit),
+        al.indent or 0,
+    )
+
+
+def _sample_alignments(ws, col_idx, sample_size=5):
+    result = []
+    for r in range(2, ws.max_row + 1):
+        cell = ws.cell(r, col_idx)
+        if cell.value not in (None, ""):
+            result.append(_alignment_tuple(cell))
+            if len(result) >= sample_size:
+                break
+    return result
+
+
+def get_column_formats(ws):
+    col_map = _header_to_column_map(ws)
+    result = {}
+
+    for header, col_idx in col_map.items():
+        fmt = None
+        for r in range(2, ws.max_row + 1):
+            c = ws.cell(r, col_idx)
+            if c.value not in (None, ""):
+                fmt = c.number_format
+                break
+        result[header] = fmt or "No data"
+
+    return result
+
+
+def _analyze_format(fmt):
+    if not fmt or fmt == "No data":
+        return {"type": "unknown", "raw": fmt}
+
+    f = fmt.lower()
+    result = {"raw": fmt}
+
+    if any(x in f for x in ["yy", "mm", "dd"]):
+        result["type"] = "date"
+    elif "$" in fmt or "€" in fmt or "£" in fmt:
+        result["type"] = "currency"
+    elif "0" in f or "#" in f:
+        result["type"] = "numeric"
+    else:
+        result["type"] = "text"
+
+    result["decimals"] = len(f.split(".")[-1]) if "." in f else 0
+    result["thousands"] = "," in f
+
+    result["currency"] = None
+    for sym in ["$", "€", "£"]:
+        if sym in fmt:
+            result["currency"] = sym
+
+    return result
+
+
+def _diff_formats(f1, f2):
+    a1 = _analyze_format(f1)
+    a2 = _analyze_format(f2)
+
+    diffs = []
+    for k in set(a1) | set(a2):
+        if a1.get(k) != a2.get(k):
+            diffs.append(f"{k}: {a1.get(k)} → {a2.get(k)}")
+    return diffs
+
+
+def compare_formatting(ws1, ws2):
+    f1 = get_column_formats(ws1)
+    f2 = get_column_formats(ws2)
+
+    diffs = []
+
+    for col in set(f1) & set(f2):
+        if f1[col] != f2[col]:
+            diff_details = _diff_formats(f1[col], f2[col])
+            diffs.append({
+                "Column": col,
+                "File1_Format": f1[col],
+                "File2_Format": f2[col],
+                "Differences": "; ".join(diff_details)
+            })
+
+    return diffs
+
+
+def compare_data_alignment(ws1, ws2):
+    m1 = _header_to_column_map(ws1)
+    m2 = _header_to_column_map(ws2)
+
+    diffs = []
+
+    for col in set(m1) & set(m2):
+        a1 = set(_sample_alignments(ws1, m1[col]))
+        a2 = set(_sample_alignments(ws2, m2[col]))
+
+        if a1 != a2:
+            diffs.append({
+                "Column": col,
+                "File1_Alignment": str(list(a1)),
+                "File2_Alignment": str(list(a2)),
+            })
+
+    return diffs
+
+
+def compare_header_alignment(ws1, ws2):
+    m1 = _header_to_column_map(ws1)
+    m2 = _header_to_column_map(ws2)
+
+    diffs = []
+
+    for col in set(m1) & set(m2):
+        a1 = _alignment_tuple(ws1.cell(1, m1[col]))
+        a2 = _alignment_tuple(ws2.cell(1, m2[col]))
+
+        if a1 != a2:
+            diffs.append({
+                "Column": col,
+                "File1_Header_Alignment": str(a1),
+                "File2_Header_Alignment": str(a2),
+            })
+
+    return diffs

compareexcel/report.py

@@ -0,0 +1,17 @@
+"""Write comparison results to an Excel workbook."""
+
+from __future__ import annotations
+
+import pandas as pd
+
+
+def write_report(output_file, formatting, data_align, header_align):
+    with pd.ExcelWriter(output_file, engine="openpyxl") as writer:
+        if formatting:
+            pd.DataFrame(formatting).to_excel(writer, sheet_name="Formatting_Diffs", index=False)
+
+        if data_align:
+            pd.DataFrame(data_align).to_excel(writer, sheet_name="Data_Alignment_Diffs", index=False)
+
+        if header_align:
+            pd.DataFrame(header_align).to_excel(writer, sheet_name="Header_Alignment_Diffs", index=False)

compareexcel-0.2.1.dist-info/METADATA

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: compareexcel
+Version: 0.2.1
+Summary: Compare two Excel workbooks for column number formats and cell alignment differences, with optional Excel report output.
+Author: Excel Compare contributors
+License-Expression: MIT
+Project-URL: Repository, https://github.com/abhidotnet/compareexcel
+Project-URL: Issues, https://github.com/abhidotnet/compareexcel/issues
+Keywords: excel,xlsx,compare,openpyxl,pandas
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas>=2.0
+Requires-Dist: openpyxl>=3.1
+Dynamic: license-file
+
+# Excel Compare (compareExcel)
+
+**compareExcel** is a small command-line tool and Python library that compares two Excel (`.xlsx`) workbooks. It reports differences in **column number formats**, **data cell alignment** (sampled from non-empty cells), and **header row alignment** for columns that exist in both files.
+
+Install from PyPI with `pip install compareexcel`. The distribution and import package name is **`compareexcel`**. Installed console scripts are **`compareexcel`** and **`compareExcel`** (same entry point).
+
+## Requirements
+
+- Python 3.10+
+- Dependencies: `pandas`, `openpyxl` (declared in `pyproject.toml`)
+
+## Installation
+
+From the repository root (`compareexcel/`):
+
+```bash
+pip install .
+```
+
+Editable install while developing:
+
+```bash
+pip install -e .
+```
+
+## Command-line usage
+
+```text
+compareExcel FILE1 FILE2 [--sheet SHEET_NAME] [--output REPORT.xlsx] [--alignment-only]
+```
+
+| Argument / option | Description |
+|-------------------|-------------|
+| `FILE1`, `FILE2` | Paths to the two Excel files to compare. |
+| `--sheet` | Compare only this sheet; default is all sheets that exist in **both** workbooks. |
+| `--output` | Write a multi-sheet Excel report (`Formatting_Diffs`, `Data_Alignment_Diffs`, `Header_Alignment_Diffs`). |
+| `--alignment-only` / `--ao` | Reserved for future use (currently parsed only). |
+
+Example:
+
+```bash
+compareExcel workbook_a.xlsx workbook_b.xlsx --output diff_report.xlsx
+```
+
+A short summary is always printed to the console; use `--output` to persist detailed rows to an `.xlsx` file.
+
+## Library usage
+
+```python
+from openpyxl import load_workbook
+from compareexcel import (
+    compare_formatting,
+    compare_data_alignment,
+    compare_header_alignment,
+    write_report,
+)
+
+wb1 = load_workbook("a.xlsx")
+wb2 = load_workbook("b.xlsx")
+sheet = wb1.sheetnames[0]
+fmt = compare_formatting(wb1[sheet], wb2[sheet])
+data_align = compare_data_alignment(wb1[sheet], wb2[sheet])
+header_align = compare_header_alignment(wb1[sheet], wb2[sheet])
+
+write_report("out.xlsx", fmt, data_align, header_align)
+```
+
+## Package layout
+
+```text
+compareexcel/
+├── src/
+│   └── compareexcel/
+│       ├── __init__.py   # Public API and version
+│       ├── cli.py        # Entry point and argument parsing
+│       ├── core.py       # Comparison logic
+│       └── report.py     # Excel report writer
+├── pyproject.toml
+├── README.md
+├── LICENSE
+└── .gitignore
+```
+
+## License
+
+See [LICENSE](LICENSE).

compareexcel-0.2.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+compareexcel/__init__.py,sha256=oJsYarXfE9XByZ2gz2QvBLMDFzf4sTkiTSOW1L5OVKc,449
+compareexcel/cli.py,sha256=uKT9nQWjiz8wy-7scaozlc6A6371AcACZqsAos5qHAc,2233
+compareexcel/core.py,sha256=pfFEpIZuXOPVrnji2-jCcbeieLf-UV0_6mE-gJdYRKo,3740
+compareexcel/report.py,sha256=NPjBjyJrFz31yhvrL0gwvcm8TgoENwCExO1L2DVeWWk,627
+compareexcel-0.2.1.dist-info/licenses/LICENSE,sha256=VBlKcwWPZXlJFE9C7XI2hvL0HXjmK44CI9RqeADM4cQ,1083
+compareexcel-0.2.1.dist-info/METADATA,sha256=TVSLc92opOh1uO8AjCiz-jMEQiy683I1RlTm9Ei8vQI,3546
+compareexcel-0.2.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+compareexcel-0.2.1.dist-info/entry_points.txt,sha256=AQPNdzbZvMI2BCnWljYSnXBHC3XHyIBED0bJpL2K74Y,92
+compareexcel-0.2.1.dist-info/top_level.txt,sha256=51FWEmNAH_R98xZ6lWiGMR7JWgpxMWy_A4jipFAGcNg,13
+compareexcel-0.2.1.dist-info/RECORD,,

compareexcel-0.2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

compareexcel-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+compareExcel = compareexcel.cli:main
+compareexcel = compareexcel.cli:main

compareexcel-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Excel Compare contributors
+
+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.

compareexcel-0.2.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+compareexcel