Gridient

A Python library designed to simplify writing complex calculations and data structures to Excel files while preserving the underlying formulas. Define your logic in Python using familiar operators and let Gridient translate it into live Excel formulas.

Features

• Define calculations using Python operators (+, -, *, /).
• Write Pandas DataFrames and Series.
• Create parameter tables.
• Apply cell styling (bold, italics, colors, etc.).
• Use custom number formatting.
• Organize output across multiple sheets using a layout system.
• Best-effort column auto-width adjustment.

Installation

pip install -r requirements.txt
pip install .

Basic Usage (Conceptual)

import gridient as gr
import pandas as pd

# Define values and parameters
initial_investment = gr.ExcelValue("Initial Investment", 1000000, format="$#,##0")
discount_rate = gr.ExcelValue("Discount Rate", 0.05, format="0.00%")
params = gr.ExcelParameterTable("Parameters", [initial_investment, discount_rate])

# Perform calculations (these become Excel formulas)
revenue = gr.ExcelSeries.from_pandas(pd.Series([100, 150, 200]), name="Revenue")
profit = revenue * 0.2
profit.name = "Profit"
profit.format = "$#,##0"

# Create layout
workbook = gr.ExcelWorkbook("report.xlsx")
layout = gr.ExcelLayout(workbook)
sheet1 = gr.ExcelSheetLayout("Dashboard")

# Add components to layout
sheet1.add(params, row=1, col=1)
sheet1.add(profit, row=5, col=1)

# Add sheet to workbook layout and write
layout.add_sheet(sheet1)
layout.write() 

TODO

• Parameters should have an option to provide a name. Such parameter shuld than be referenced by name in formulas. There should be a unique-ness check.
• Check rules for parameter names.
• Add themes: The user would pick a theme and it would style tables and values accordingly.
• Support for directly touching the xlsxwriter API.
• Support for hooks. Such that user can override internal data structures at any step of the process.
• Bug: There is an extra parenthesis in for example =IF((B1>0),1,0) which should not be there.