Merge branch 'Mrinank-Bhowmick:main' into computer-algebra

Author: ca20110820

README.md

@@ -56,13 +56,25 @@ def average():
 
 
 def factorial(num):
+    """
+    Function to calculate the factorial of a number. 
+    
+    Takes a number as an argument, calculates the factorial of the number,
+    and returns the result.
+    """
     answer = 1
     for i in range(num):
         answer *= i + 1
     return answer
 
 
 def complex_arithmetic():
+    """
+    Function to execute complex arithmetic operations such as addition, subtraction, multiplication, and division.
+    
+    Asks the user to choose the operation and input the complex numbers as real and imaginary parts,
+    performs the operation, and returns the result.
+    """
     print("Enter '1' for complex addition")
     print("Enter '2' for complex subtraction")
     print("Enter '3' for complex multiplication")
@@ -118,6 +130,12 @@ def complex_arithmetic():
 
 
 def binomial(num):
+    """
+    Function to calculate the binomial coefficient.
+    
+    Takes two numbers as arguments, calculates the binomial coefficient using the formula n!/(k!(n-k)!),
+    and returns the result.
+    """
     result = factorial(num[0]) / (factorial(num[1]) * factorial(num[0] - num[1]))
     return result
 

projects/Calculator/main.py

@@ -1,49 +1,46 @@
-# Program to display calendar
-
-
-def display_calendar(year, month):
+def display_cal(year_input, month_input):
     """
-    Display a calendar for the given year and month.
+    Display a calendar for the desired year and month.
 
     Parameters:
-    year (int): The year for which the calendar is to be displayed.
-    month (int): The month for which the calendar is to be displayed.
+    year_input (int): The year for which the calendar is to be displayed.
+    month_input (int): The month for which the calendar is to be displayed.
 
     """
     import calendar
 
-    print(calendar.month(year, month))
+    print(calendar.month(year_input, month_input))
 
 
-def get_valid_year():
+def fetch_year():
     """
-    Function to prompt the user for a valid year input and return the valid year as an integer.
+    Prompts the user for a valid year and returns the year as an integer.
     """
     while True:
         try:
-            year = int(input("Enter year: "))
-            if year < 0:
+            year_input = int(input("Enter year: "))
+            if year_input < 0:
                 raise ValueError("Year must be a positive integer")
-            return year
+            return year_input
         except ValueError:
             print("Invalid input. Please enter a valid year.")
 
 
-def get_valid_month():
+def fetch_month():
     """
-    A function that prompts the user to enter a month, validates the input, and returns the valid month.
+    Function that asks the user to enter a month, validates the input, and returns the valid month.
     """
     while True:
         try:
-            month = int(input("Enter month: "))
-            if month < 1 or month > 12:
+            month_input = int(input("Enter month: "))
+            if month_input < 1 or month_input > 12:
                 raise ValueError("Month must be between 1 and 12")
-            return month
+            return month_input
         except ValueError:
             print("Invalid input. Please enter a valid month.")
 
 
-year = get_valid_year()
-month = get_valid_month()
+year_input = fetch_year()
+month_input = fetch_month()
 
-display_calendar(year, month)
+display_cal(year_input, month_input)

projects/Calendar/displayCalendar.py

@@ -0,0 +1,116 @@
+# Expense Tracker Application
+
+The Expense Tracker Application is a GUI application built using Python and
+Customtkinter/Tkinter for
+managing expenses. It allows users to add, update, and delete expense items, generate reports in Excel and PDF formats,
+and visualize expense data by category.
+
+---
+
+## Features
+
+- Add, update, and delete expense items.
+- Generate reports in Excel and PDF formats.
+- Visualize expense data by category.
+- User-friendly graphical interface.
+
+---
+
+## Installation
+
+1. Clone the [python-beginner-projects](https://github.com/Mrinank-Bhowmick/python-beginner-projects) repository to your
+   local machine:
+
+   ```
+   git clone https://github.com/Mrinank-Bhowmick/python-beginner-projects.git
+   ```
+
+2. Navigate to the project directory:
+
+   ```
+   cd python-beginner-projects/projects/Expense-Tracker
+   ```
+
+3. Install the required dependencies:
+
+   ```
+   pip install -r requirements.txt
+   ```
+
+---
+
+## Usage
+
+1. Run the application:
+
+   ```
+   python app.py
+   ```
+
+2. The Expense Tracker GUI will open, allowing you to interact with the application.
+
+3. Add, update, or delete expense items using the provided form and buttons.
+
+4. Generate reports by navigating to the "Report" tab and clicking on the respective buttons for Excel or PDF reports.
+
+5. Visualize expense data by navigating to the "Summary By Category" tab.
+
+You can also run the sample using:
+
+```
+python sample.py
+```
+
+which would use dummy data to test the app.
+
+---
+
+## Screenshots
+
+### Adding Item
+
+![Adding Item](media/adding-item.gif)
+
+### Updating Item
+
+![Updating Item](media/updating-items.gif)
+
+### Deleting Items
+
+![Deleting Items](media/deleting-items.gif)
+
+### Viewing Summary Statistics
+
+![Summary Statistics](media/summary-stats.gif)
+
+### Generating Reports
+
+![Generating Reports](media/generating-reports.gif)
+
+### Excel Report
+
+![Excel Report 1](media/report-excel-1.JPG)
+![Excel Report 2](media/report-excel-2.JPG)
+
+### PDF Report
+
+![PDF Report](media/report-pdf.JPG)
+
+
+---
+
+## Tasks
+
+- [X] Expense Categorization: This feature allows users to classify their expenses into categories like food,
+  transportation, and entertainment, and provides a summary based on these categories.
+- [X] Date Range Filtering: This feature enables users to filter and view their expenses within a specific date range.
+- [X] Expense Analysis: This feature offers statistical insights such as the average expense, highest expense, lowest
+  expense, etc.
+- [X] Data Saving and Loading: This feature lets users save their expense data to a file (like CSV or JSON) and load it
+  back when needed.
+- [X] Data Export to PDF/Excel: This feature enables users to export their expense data to common formats like PDF or
+  Excel for easy sharing or printing.
+- [ ] Currency Converter: For users dealing with multiple currencies, this feature provides an option to convert
+  expenses to a preferred currency.
+
+