added detail

hyna123 · hyna123 · commit 272c693853d6 · 2023-10-25T23:22:13.000+05:00
diff --git a/E/expense_Tracker/README.md b/E/expense_Tracker/README.md
@@ -0,0 +1,87 @@
+
+
+## Table of Contents listed
+
+- 📑[Table of Contents](#table-of-contents)
+- 🧾[Introduction](#introduction)
+- ✨[Features](#features)
+- 🛠️[How to Use](#how-to-use)
+- ⚙️[Installation](#installation)
+- 🙌[How to Contribute](#how-to-contribute)
+- 📝[License](#license)
+
+## Introduction
+
+Managing a family's finances can be challenging, especially when dealing with multiple sources of income and various expenses. The Family Expense Tracker simplifies this task by providing a user-friendly interface to:
+
+- 💼 Add Family Members
+- 💵 Record Earnings for Each Family Member
+- 📉 Track Expenses
+- 💰 Calculate Remaining Balance
+
+With this tool, you can easily monitor and manage your family's financial situation.
+
+## Features
+
+- **Add Family Members:** Start by adding the names of family members whose earnings and expenses you want to track.
+- **Record Earnings:** Record the earnings for each family member. The tracker calculates the total earnings for the family.
+- **Track Expenses:** Log various expenses, and the tracker deducts these from the total earnings, showing the remaining balance.
+- **User-Friendly Interface:**
+
+The Expense Tracker features a simple and easy-to-navigate interface, ensuring a seamless user experience, allowing you to effortlessly manage your family's financial data.
+
+## How to Use
+
+1. **Add Family Members:**
+   - Run the [application](https://expense-tracker-alpha.streamlit.app/) and choose the option to add family members.
+   - Enter the names of the family members you want to track.
+
+2. **Record Earnings:**
+   - Select the option to record earnings.
+   - Specify the earnings for each family member.
+
+3. **Track Expenses:**
+   - Log expenses for various categories (e.g., groceries, bills).
+   - The application automatically calculates the remaining balance after deducting expenses.
+
+## Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/sree-hari-s/Expense-Tracker.git
+   cd Expense-Tracker
+   ```
+
+2. Install the required dependencies
+
+   ```bash
+    pip install -r requirements.txt
+    ```
+
+3. Run the Application
+
+   Now you can run the Family Expense Tracker application using Streamlit:
+
+    ```bash
+    streamlit run app.py
+    ```
+
+## How to Contribute
+
+- If you wish to [contribute](CONTRIBUTING.md) in any way, feel free to get involved. You can suggest improvements or provide support and encouragement by [opening an issue](https://github.com/sree-hari-s/Expense-Tracker/issues).
+
+## Contributors
+
+Thank you all for, your contributions. Your contributions hold immense value for our project, and we are genuinely thankful for your valuable support. Your unwavering commitment and hard work are truly commendable.
+
+<p align="center">
+  <a href="https://github.com/sree-hari-s/Expense-Tracker/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=sree-hari-s/Expense-Tracker" alt="Contributors" />
+  </a>
+</p>
+
+
+## License
+
+This project is licensed under the terms of the [MIT License](LICENSE).
diff --git a/E/expense_Tracker/app.py b/E/expense_Tracker/app.py
@@ -0,0 +1,212 @@
+import streamlit as st
+from main import FamilyExpenseTracker
+import matplotlib.pyplot as plt
+from streamlit_option_menu import option_menu
+
+# Streamlit configuration
+st.set_page_config(page_title="Family Expense Tracker", page_icon="💰")
+
+st.title("")  # Clear the default title
+
+# Hide Streamlit Style
+hide_st_style = """
+            <style>
+            #MainMenu {visibility: hidden;}
+            footer {visibility: hidden;}
+            header {visibility: hidden;}
+            </style>
+            """
+st.markdown(hide_st_style, unsafe_allow_html=True)
+
+# Create a session state object
+session_state = st.session_state
+
+# Check if the 'expense_tracker' object exists in the session state
+if "expense_tracker" not in session_state:
+    # If not, create and initialize it
+    session_state.expense_tracker = FamilyExpenseTracker()
+
+# Center-align the heading using HTML
+st.markdown(
+    '<h1 style="text-align: center;">Family Expense Tracker</h1>',
+    unsafe_allow_html=True,
+)
+
+# Navigation Menu
+selected = option_menu(
+    menu_title=None,
+    options=["Data Entry", "Data Overview", "Data Visualization"],
+    icons=[
+        "pencil-fill",
+        "clipboard2-data",
+        "bar-chart-fill",
+    ],  # https://icons.getbootstrap.com/
+    orientation="horizontal",
+)
+
+# Access the 'expense_tracker' object from session state
+expense_tracker = session_state.expense_tracker
+
+if selected == "Data Entry":
+    st.header("Add Family Member")
+    with st.expander("Add Family Member"):
+        # Sidebar for adding family members
+        member_name = st.text_input("Name").title()
+        earning_status = st.checkbox("Earning Status")
+        if earning_status:
+            earnings = st.number_input("Earnings", value=1, min_value=1)
+        else:
+            earnings = 0
+
+        if st.button("Add Member"):
+            try:
+                # Check if family member exists
+                member = [
+                    member
+                    for member in expense_tracker.members
+                    if member.name == member_name
+                ]
+                # If not exist add family member
+                if not member:
+                    expense_tracker.add_family_member(
+                        member_name, earning_status, earnings
+                    )
+                    st.success("Member added successfully!")
+                # Else, update it
+                else:
+                    expense_tracker.update_family_member(
+                        member[0], earning_status, earnings
+                    )
+                    st.success("Member updated successfully!")
+            except ValueError as e:
+                st.error(str(e))
+
+    # Sidebar for adding expenses
+    st.header("Add Expenses")
+    with st.expander("Add Expenses"):
+        expense_category = st.selectbox(
+            "Category",
+            (
+                "Housing",
+                "Food",
+                "Transportation",
+                "Entertainment",
+                "Child-Related",
+                "Medical",
+                "Investment",
+                "Miscellaneous",
+            ),
+        )
+        expense_description = st.text_input("Description (optional)").title()
+        expense_value = st.number_input("Value", min_value=0)
+        expense_date = st.date_input("Date", value="today")
+
+        if st.button("Add Expense"):
+            try:
+                # Add the expense
+                expense_tracker.merge_similar_category(
+                    expense_value, expense_category, expense_description, expense_date
+                )
+                st.success("Expense added successfully!")
+            except ValueError as e:
+                st.error(str(e))
+elif selected == "Data Overview":
+    # Display family members
+    if not expense_tracker.members:
+        st.info(
+            "Start by adding family members to track your expenses together! Currently, no members have been added. Get started by clicking the 'Add Member' from the Data Entry Tab"
+        )
+    else:
+        st.header("Family Members")
+        (
+            name_column,
+            earning_status_column,
+            earnings_column,
+            family_delete_column,
+        ) = st.columns(4)
+        name_column.write("**Name**")
+        earning_status_column.write("**Earning status**")
+        earnings_column.write("**Earnings**")
+        family_delete_column.write("**Action**")
+
+        for member in expense_tracker.members:
+            name_column.write(member.name)
+            earning_status_column.write(
+                "Earning" if member.earning_status else "Not Earning"
+            )
+            earnings_column.write(member.earnings)
+
+            if family_delete_column.button(f"Delete {member.name}"):
+                expense_tracker.delete_family_member(member)
+                st.rerun()
+
+        # Display expenses
+        st.header("Expenses")
+        if not expense_tracker.expense_list:
+            st.info(
+            "Currently, no expenses have been added. Get started by clicking the 'Add Expenses' from the Data Entry Tab"
+        )
+        else:
+            (
+                value_column,
+                category_column,
+                description_column,
+                date_column,
+                expense_delete_column,
+            ) = st.columns(5)
+            value_column.write("**Value**")
+            category_column.write("**Category**")
+            description_column.write("**Description**")
+            date_column.write("**Date**")
+            expense_delete_column.write("**Delete**")
+
+            for expense in expense_tracker.expense_list:
+                value_column.write(expense.value)
+                category_column.write(expense.category)
+                description_column.write(expense.description)
+                date_column.write(expense.date)
+
+                if expense_delete_column.button(f"Delete {expense.category}"):
+                    expense_tracker.delete_expense(expense)
+                    st.rerun()
+
+        total_earnings = expense_tracker.calculate_total_earnings()               # Calculate total earnings
+        total_expenditure = expense_tracker.calculate_total_expenditure()         # Calculate total expenditure
+        remaining_balance = total_earnings - total_expenditure                    # Calculate remaining balance
+        col1, col2, col3 = st.columns(3)
+        col1.metric("Total Earnings", f"{total_earnings}")          # Display total earnings
+        col2.metric("Total Expenditure", f"{total_expenditure}")    # Display total expenditure 
+        col3.metric("Remaining Balance", f"{remaining_balance}")    # Display remaining balance 
+
+elif selected == "Data Visualization":
+    # Create a list of expenses and their values
+    expense_data = [
+        (expense.category, expense.value) for expense in expense_tracker.expense_list
+    ]
+    if expense_data:
+        # Calculate the percentage of expenses for the pie chart
+        expenses = [data[0] for data in expense_data]
+        values = [data[1] for data in expense_data]
+        total = sum(values)
+        percentages = [(value / total) * 100 for value in values]
+
+        # Create a smaller pie chart with a transparent background
+        fig, ax = plt.subplots(figsize=(3, 3), dpi=300)
+        ax.pie(
+            percentages,
+            labels=expenses,
+            autopct="%1.1f%%",
+            startangle=140,
+            textprops={"fontsize": 6, "color": "white"},
+        )
+        ax.set_title("Expense Distribution", fontsize=12, color="white")
+
+        # Set the background color to be transparent
+        fig.patch.set_facecolor("none")
+
+        # Display the pie chart in Streamlit
+        st.pyplot(fig)
+    else:
+        st.info(
+            "Start by adding family members to track your expenses together! Currently, no members have been added. Get started by clicking the 'Add Member' from the Data Entry Tab."
+        )
diff --git a/E/expense_Tracker/main.py b/E/expense_Tracker/main.py
@@ -0,0 +1,89 @@
+class FamilyMember:
+    def __init__(self, name, earning_status=True, earnings=0):
+        self.name = name
+        self.earning_status = earning_status
+        self.earnings = earnings
+
+    def __str__(self):
+        return (
+            f"Name: {self.name}, Earning Status: {'Earning' if self.earning_status else 'Not Earning'}, "
+            f"Earnings: {self.earnings}"
+        )
+
+
+class Expense:
+    def __init__(self, value, category, description, date):
+        self.value = value
+        self.category = category
+        self.description = description
+        self.date = date
+
+    def __str__(self):
+        return f"Value: {self.value}, Category: {self.category}, Description: {self.description}, Date: {self.date}"
+
+
+class FamilyExpenseTracker:
+    def __init__(self):
+        self.members = []
+        self.expense_list = []
+
+    def add_family_member(self, name, earning_status=True, earnings=0):
+        if not name.strip():
+            raise ValueError("Name field cannot be empty")
+
+        member = FamilyMember(name, earning_status, earnings)
+        self.members.append(member)
+    
+    def delete_family_member(self, member):
+        self.members.remove(member)
+
+    def update_family_member(self, member, earning_status=True, earnings=0):
+        if member:
+            member.earning_status = earning_status
+            member.earnings = earnings
+
+    def calculate_total_earnings(self):
+        total_earnings = sum(
+            member.earnings for member in self.members if member.earning_status
+        )
+        return total_earnings
+
+    def add_expense(self, value, category, description, date):
+        if value == 0:
+            raise ValueError("Value cannot be zero")
+        if not category.strip():
+            raise ValueError("Please choose a category")
+
+        expense = Expense(value, category, description, date)
+        self.expense_list.append(expense)
+
+    def delete_expense(self,expense):
+        self.expense_list.remove(expense)
+
+
+    def merge_similar_category(self, value, category, description, date):
+        if value == 0:
+            raise ValueError("Value cannot be zero")
+        if not category.strip():
+            raise ValueError("Please choose a category")
+
+        existing_expense = None
+        for expense in self.expense_list:
+            if expense.category == category:
+                existing_expense = expense
+                break
+
+        if existing_expense:
+            existing_expense.value += value
+            if description:
+                existing_expense.description = description
+        else:
+            self.add_expense(value, category, description, date)
+
+    def calculate_total_expenditure(self):
+        total_expenditure = sum(expense.value for expense in self.expense_list)
+        return total_expenditure
+
+
+if __name__ == "__main__":
+    expense_tracker = FamilyExpenseTracker()
