debt_optimizer.excel_io.excel_reader module

Module documentation for excel_reader.py.

This module is part of the Financial Debt Optimizer project.

class debt_optimizer.excel_io.excel_reader.ExcelReader(file_path)

Bases: object

Read financial data from Excel files.

Parameters:

file_path (str)

__init__(file_path)

Initialize with path to Excel file.

Parameters:

file_path (str)

read_all_data()

Read all data from Excel file and return debts, income, recurring expenses, future income, future expenses, and settings.

Return type:

Tuple[List[Debt], List[Income], List[RecurringExpense], List[FutureIncome], List[FutureExpense], Dict[str, Any]]

read_debts(sheet_name='Debts')

Read debt information from Excel file.

Return type:

List[Debt]

Parameters:

sheet_name (str)

read_income(sheet_name='Income')

Read income information from Excel file.

Return type:

List[Income]

Parameters:

sheet_name (str)

read_recurring_expenses(sheet_name='Recurring Expenses')

Read recurring expenses from Excel file.

Return type:

List[RecurringExpense]

Parameters:

sheet_name (str)

read_future_income(sheet_name='Future Income')

Read future income events from Excel file - supports both one-time and recurring income.

Return type:

List[FutureIncome]

Parameters:

sheet_name (str)

read_future_expenses(sheet_name='Future Expenses')

Read future expense events from Excel file - supports both one-time and recurring expenses.

Return type:

List[FutureExpense]

Parameters:

sheet_name (str)

read_settings(sheet_name='Settings')

Read settings from Excel file.

Return type:

Dict[str, Any]

Parameters:

sheet_name (str)

class debt_optimizer.excel_io.excel_reader.ExcelTemplateGenerator

Bases: object

Generate Excel templates for data input.

static generate_template(output_path, include_sample_data=True)

Generate a template Excel file with all required sheets.

Parameters:

• output_path (str)

• include_sample_data (bool)