feat: completed initial prototype for expense-tracker

todo - Currency Converter

todo - local settings and ui

todo - separation of expense and income

Author: ca20110820

projects/Expense-Tracker/app.py

@@ -2,10 +2,13 @@
 from tkinter import ttk
 from tkinter import messagebox
 import customtkinter as ctk
+
 from datetime import datetime
+from pathlib import Path
 
-from gui_widgets import *
-from item import ItemsDB
+from gui_widgets import ItemsTable, SummaryByCategoryPivotTable
+from item import ItemsDB, Category, Item
+from expense_income_stats import ExcelReport, PdfReport
 
 
 class App(ctk.CTk):
@@ -44,38 +47,24 @@ def __init__(self, db_path, *args, **kwargs):
                                )
         button.pack(pady=5)
 
-        # # Button for Clearing the Items in the Table (Not Deleting from Json)
-        # self.btn_clear_all_items = ctk.CTkButton(self.tab_view_settings.tab('Edit'),
-        #                                          text='Clear Items',
-        #                                          command=lambda: self.items_table.clear_items(),
-        #                                          )
-        # self.btn_clear_all_items.pack(pady=5)
-        #
-        # def lesson_option(choice):
-        #     lesson_number = int(choice) - 1
-        #     return lesson_number
-        #
-        # optionbox_var = ctk.StringVar(value="1")
-        # optionbox = ctk.CTkOptionMenu(self.tab_view_settings.tab('Edit'),
-        #                               values=['1', '2'],
-        #                               variable=optionbox_var,
-        #                               command=lesson_option)
-        # optionbox.pack()
+        button = ctk.CTkButton(self.tab_view_settings.tab('Edit'),
+                               text='Update Summaries',
+                               command=self.update_pivot_tables,
+                               )
+        button.pack(pady=5)
 
         # Report Tab
         self.tab_view_settings.add('Report')
 
-        # TODO: Create Event-handler for Generating Excel Report
         self.btn_generate_excel_report = ctk.CTkButton(self.tab_view_settings.tab('Report'),
                                                        text='Generate Excel Report',
-                                                       command=lambda: print('Generating Excel Report ...'),
+                                                       command=self.generate_excel_report,
                                                        )
         self.btn_generate_excel_report.pack(pady=5)
 
-        # TODO: Create Event-handler for Generating PDF Report
         self.btn_generate_pdf_report = ctk.CTkButton(self.tab_view_settings.tab('Report'),
                                                      text='Generate PDF Report',
-                                                     command=lambda: print('Generating PDF Report ...'),
+                                                     command=self.generate_pdf_report,
                                                      )
         self.btn_generate_pdf_report.pack(pady=5)
 
@@ -169,21 +158,32 @@ def __init__(self, db_path, *args, **kwargs):
         # CTkTabview for Visualizations
         self.tab_view_visuals = ctk.CTkTabview(self)
         self.tab_view_visuals.grid(row=2, column=0, padx=5, pady=5, columnspan=3, sticky='nswe')
-        self.tab_view_visuals.add("Expense Summary")  # Expense Summary Tab
-        self.tab_view_visuals.add("Income Summary")  # add tab at the end
-        self.tab_view_visuals.set("Expense Summary")  # set currently visible tab
 
-        # TODO: Expense Summary Tab Contents
-        label = ctk.CTkLabel(master=self.tab_view_visuals.tab('Expense Summary'), text="Under Construction",
-                             fg_color="red")
-        label.pack()
+        expense_tab = self.tab_view_visuals.add(
+            "Summary By Category")  # Summary By Category Tab
+
+        self.tab_view_visuals.set("Summary By Category")  # set currently visible tab
 
-        # TODO: Income Summary Tab Contents
+        # Summary By Category Tab Contents
+        self.pivot_table = SummaryByCategoryPivotTable(self.tab_view_visuals.tab('Summary By Category'))
 
         # ==============================================================================================================
         # Other Widget-Event-Callbacks Bindings
         self.protocol("WM_DELETE_WINDOW", self.on_window_close)
 
+    def update_pivot_tables(self):
+        self.pivot_table.update_pivot_table()
+
+    def generate_excel_report(self):
+        excel_path = str(Path(__file__).resolve().parent / 'report.xlsx')
+        report = ExcelReport(excel_path, self._items_db)
+        report.generate_report()
+
+    def generate_pdf_report(self):
+        pdf_path = str(Path(__file__).resolve().parent / 'report.pdf')
+        report = PdfReport(pdf_path, self._items_db)
+        report.generate_report()
+
     def on_window_close(self):
         # Reference: https://stackoverflow.com/questions/111155/how-do-i-handle-the-window-close-event-in-tkinter
         print('Window Closing ...')
@@ -200,10 +200,6 @@ def _get_form_values(self):
             'subcategory': self.entry_subcategory.get(),
         }
 
-    def _validate_form_values(self):
-        # TODO: Add Form Entry Validations
-        pass
-
     def clear_form(self):
         self.entry_name.delete(0, last_index=len(self.entry_name.get()))
         self.entry_amount.delete(0, last_index=len(self.entry_amount.get()))
@@ -221,13 +217,6 @@ def fill_form(self, name, amount, description, date, category='None', subcategor
         self.entry_category.insert(0, category)
         self.entry_subcategory.insert(0, subcategory)
 
-        # self.entry_name.configure(placeholder_text=name)
-        # self.entry_amount.configure(placeholder_text=amount)
-        # self.entry_date.configure(textvariable=date)
-        # self.entry_description.configure(placeholder_text=description)
-        # self.entry_category.configure(placeholder_text=category)
-        # self.entry_subcategory.configure(placeholder_text=subcategory)
-
     def on_btn_add_clicked(self):
         new_item = self._create_item_from_form()
 
@@ -259,10 +248,9 @@ def on_btn_update_clicked(self):
             item_obj.amount = float(self.entry_amount.get().strip())
             item_obj.description = self.entry_description.get().strip()
             item_obj.date = datetime.strptime(self.entry_date.get().strip(), '%Y-%m-%d %H:%M:%S')
-            item_obj.category = \
-                None if self.entry_category.get() == 'None' else \
-                    Category(self.entry_category.get().strip()) if self.entry_subcategory.get().strip() == 'None' else \
-                        Category(self.entry_category.get().strip(), self.entry_subcategory.get().strip())
+            item_obj.category = None if self.entry_category.get() == 'None' else Category(
+                self.entry_category.get().strip()) if self.entry_subcategory.get().strip() == 'None' else Category(
+                self.entry_category.get().strip(), self.entry_subcategory.get().strip())
 
         except ValueError as value_error:
             messagebox.showerror('Error', str(value_error))
@@ -341,7 +329,7 @@ def _create_item_from_form(self) -> Item | None:
 
             temp_item = Item.create(
                 self.entry_name.get(),
-                self.entry_amount.get(),
+                float(self.entry_amount.get()),
                 self.entry_description.get(),
                 self.entry_date.get(),
                 category
@@ -354,14 +342,16 @@ def _create_item_from_form(self) -> Item | None:
     def on_row_selected(self, e):
         # Reference: https://stackoverflow.com/questions/30614279/tkinter-treeview-get-selected-item-values
 
+        # Reference: For Multiple Selected Rows
+        # https://stackoverflow.com/questions/48867800/tk-treeview-focus-how-do-i-get-multiple-selected-lines
+
         # Set the Selected Item for the TreeView
         selected_item = self.items_table.focus()
         item_dct = self.items_table.item(selected_item)
 
         values = item_dct['values']
         item_id = item_dct['text']
         row = [item_id] + list(values)
-        print(row)
 
         self.fill_form(
             values[0],
@@ -371,9 +361,3 @@ def on_row_selected(self, e):
             category=values[4],
             subcategory=values[5]
         )
-
-    # def on_rows_selected(self, e):
-    #     # Reference: https://stackoverflow.com/questions/48867800/tk-treeview-focus-how-do-i-get-multiple-selected-lines
-    #     selected_items = self.items_table.selection()  # Gets the Selected Items from TreeView Table
-    #     # self.items_table.selection_set(selected_items)
-    #     selected_items = [self.items_table.item(selected_item) for selected_item in selected_items]

projects/Expense-Tracker/expense_income_stats.py

@@ -1,6 +1,8 @@
 from abc import ABC, abstractmethod
 from item import ItemsDB
+import pandas as pd
 import statistics
+from reportlab.pdfgen import canvas
 
 
 class ExpenseIncomeStats:
@@ -9,22 +11,6 @@ def __init__(self, db_path: str, start: str = None, end: str = None):
         self.start = start
         self.end = end
 
-        # if start is None and end is None:
-        #     # Get all Items
-        #     self._items = self._items_db.get_all_items()
-        #     pass
-        # elif start is None and end is not None:
-        #     # Start from the Oldest Item(s) to the given end date string
-        #     oldest = min(item.date for item in self._items_db.get_all_items())
-        #     self._items = self._items_db.get_items_by_date_range(oldest.strftime("%Y-%m-%d"), end)
-        # elif start is not None and end is None:
-        #     # Start from the given start date string to the latest date
-        #     latest = max(item.date for item in self._items_db.get_all_items())
-        #     self._items = self._items_db.get_items_by_date_range(start, latest.strftime("%Y-%m-%d"))
-        # else:
-        #     # Get item from given date range
-        #     self._items = self._items_db.get_items_by_date_range(start, end)
-
     @property
     def items(self):
         return self._items_db.get_all_items()
@@ -92,26 +78,115 @@ def get_stats_by_category_with_subcategories(self) -> dict:
 
         return stats_dict
 
-    @staticmethod
-    def currency_converter(base_currency: str, quote_currency: str) -> float:
-        # TODO: Implement currency_converter() method.
-        pass
-
 
 class Report(ABC):
+    def __init__(self, file_path: str, items_db: ItemsDB):
+        self.file_path = file_path
+        self.items_db = items_db
+
     @abstractmethod
     def generate_report(self, *args, **kwargs):
         pass
 
+    @staticmethod
+    def to_dataframe(items) -> pd.DataFrame:
+        # items: List[Item]
 
-class ExcelReport(Report):
-    def __init__(self, file_path: str):
-        self.file_path = file_path
+        rows = []
+        for item in items:
+            category = item.category
+            row = {k: v for k, v in item.__dict__.items() if k != 'category'}
+
+            if category is not None:
+                row['category'] = category.name
+                if category.subcategory is not None:
+                    row['subcategory'] = category.subcategory
+
+            rows.append(row)
+
+        return pd.DataFrame(rows)
 
+
+class ExcelReport(Report):
     def generate_report(self):
-        pass
+        # TODO: Enhance - Include the Items without Category or Subcategory
+        items = self.items_db.get_all_items()
+        df = self.to_dataframe(items)
+
+        with pd.ExcelWriter(self.file_path, engine='xlsxwriter') as writer:
+            workbook = writer.book
+
+            # Raw Data Tab
+            df.to_excel(
+                writer,
+                'Data',  # worksheet name
+                index=False  # index does not contain relevant information
+            )
+            summary_sheet = writer.sheets['Data']  # Assigning a variable to the sheet allows formatting
+
+            # Pivot Table Tab
+            pivot_table = df.pivot_table(
+                values='amount',
+                index=['category', 'subcategory'],
+                aggfunc={
+                    'amount': ['mean', 'max', 'min'],
+                }
+            )
+
+            # Flatten the hierarchical column index
+            pivot_table.columns = [f'{agg}_amount' for agg in pivot_table.columns]
+
+            pivot_table.to_excel(
+                writer,
+                'Summary By Category',  # worksheet name
+                index=True  # index does not contain relevant information
+            )
+            summary_sheet = writer.sheets['Summary By Category']
 
 
 class PdfReport(Report):
     def generate_report(self):
-        pass
+        items = self.items_db.get_all_items()
+        df = self.to_dataframe(items)
+
+        from reportlab.lib import colors
+        from reportlab.lib.pagesizes import letter
+        from reportlab.platypus import SimpleDocTemplate, Table, TableStyle
+
+        # Pivot Table Tab
+        pivot_table = df.pivot_table(
+            values='amount',
+            index=['category', 'subcategory'],
+            aggfunc={
+                'amount': ['mean', 'max', 'min'],
+            }
+        )
+        pivot_table = pivot_table.reset_index()
+
+        # Convert DataFrame to a list of lists for the table
+        table_data = [list(pivot_table.columns)] + pivot_table.values.tolist()
+
+        # Create PDF
+        pdf_filename = self.file_path
+        doc = SimpleDocTemplate(pdf_filename, pagesize=letter)
+        elements = []
+
+        # Create table
+        table = Table(table_data)
+
+        # Style the table
+        style = TableStyle([('BACKGROUND', (0, 0), (-1, 0), colors.gray),
+                            ('TEXTCOLOR', (0, 0), (-1, 0), colors.whitesmoke),
+                            ('ALIGN', (0, 0), (-1, -1), 'CENTER'),
+                            ('FONTNAME', (0, 0), (-1, 0), 'Helvetica-Bold'),
+                            ('BOTTOMPADDING', (0, 0), (-1, 0), 12),
+                            ('BACKGROUND', (0, 1), (-1, -1), colors.beige),
+                            ('GRID', (0, 0), (-1, -1), 1, colors.black)])
+
+        table.setStyle(style)
+
+        # Add table to elements
+        elements.append(table)
+
+        # Build PDF
+        doc.build(elements)