adding a streamlit application

.github/workflows/hf-space.yml

@@ -0,0 +1,19 @@
+name: Sync to Hugging Face hub
+on:
+  push:
+    branches: [main]
+  # to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  sync-to-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          lfs: true
+      - name: Push to hub
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: git push https://mattoofahad:[email protected]/spaces/mattoofahad/Net-Salary-Calculator main

app.py

@@ -0,0 +1,85 @@
+import streamlit as st
+
+from functions import Functions, StreamlitFunctions
+import pandas as pd
+
+StreamlitFunctions.initialize_session_values()
+StreamlitFunctions.print_tax_brackets()
+StreamlitFunctions.reset_tax_brackets()
+
+StreamlitFunctions.print_salary_parameters()
+StreamlitFunctions.reset_salary_parameters()
+
+StreamlitFunctions.initial_salary_parameter()
+StreamlitFunctions.reset_initial_salary_parameter()
+StreamlitFunctions.check_initial_salary_parameter()
+
+if st.button("Calculate", use_container_width=True) and st.session_state.valid_input:
+    if st.session_state.user_initial_desired_net > 0:
+        initial_desired_net = st.session_state.user_initial_desired_net
+    else:
+        initial_desired_net = Functions.calculated_initial_desired_net(
+            st.session_state.current_salary,
+            st.session_state.desired_increment_percentage,
+            st.session_state.daily_cost_of_travel,
+            st.session_state.physical_days_per_week,
+        )
+
+    result = Functions.calculate_additional_amount(
+        initial_desired_net, st.session_state.tax_brackets
+    )
+    st.header("Salary Calculation Results")
+    col1, col2 = st.columns(2)
+    with col1:
+        # custom_metric("Initial Desired Net Salary", result['initial_desired_net'])
+        StreamlitFunctions.custom_metric("Final Net Salary", result["final_net_salary"])
+        StreamlitFunctions.custom_metric("Tax", result["tax"])
+
+    with col2:
+        # custom_metric("Additional Amount Needed", result['additional_amount'])
+        StreamlitFunctions.custom_metric(
+            "Gross Salary Needed", result["gross_salary_needed"]
+        )
+
+    # Display how initial_desired_net was determined
+    st.markdown("---")
+    if st.session_state.user_initial_desired_net > 0:
+        st.success("✅ Initial Desired Net Salary was provided by the user.")
+    else:
+        st.info(
+            "ℹ️ Initial Desired Net Salary was calculated based on the provided parameters."
+        )
+
+    # Display a summary of the calculation
+    st.subheader("Calculation Summary")
+    summary_df = pd.DataFrame(
+        {
+            "Parameter": [
+                "Current Salary",
+                "Desired Increment",
+                "Daily Travel Cost",
+                "On-Site Days/Week",
+                "Gross Salary",
+                "Tax",
+                "Final Net Salary",
+            ],
+            "Value": [
+                f"PKR {st.session_state.current_salary:,.2f}",
+                f"{st.session_state.desired_increment_percentage:.2%}",
+                f"PKR {st.session_state.daily_cost_of_travel:,.2f}",
+                f"{st.session_state.physical_days_per_week}",
+                f"PKR {result['gross_salary_needed']:,.2f}",
+                f"PKR {result['tax']:,.2f}",
+                f"PKR {result['final_net_salary']:,.2f}",
+            ],
+        }
+    )
+    st.table(summary_df)
+
+    st.subheader("Salary Breakdown")
+    breakdown_data = {
+        "Component": ["Net Salary", "Tax"],
+        "Amount": [result["final_net_salary"], result["tax"]],
+    }
+    breakdown_df = pd.DataFrame(breakdown_data)
+    st.bar_chart(breakdown_df.set_index("Component"))

constants.py

@@ -0,0 +1,37 @@
+class Constants:
+    DEFAULT_CURRENT_SALARY = 100000.0
+    DEFAULT_INCREMENT_PERCENTAGE = 0.3
+    DEFAULT_DAILY_TRAVEL_COST = 1500
+    DEFAULT_PHYSICAL_DAYS = 5
+    DEFAULT_INITIAL_NET = 0.0
+
+    DEFAULT_TAX_BRACKETS = [
+        (0, 600000, 0),
+        (600000, 1200000, 0.05),
+        (1200000, 2200000, 0.15),
+        (2200000, 3200000, 0.25),
+        (3200000, 4100000, 0.30),
+        (4100000, float("inf"), 0.35),
+    ]
+
+class Styles:
+    METRIC_STYLE = """
+    <style>
+    .metric-container {
+        background-color: #f0f2f6;
+        border-radius: 7px;
+        padding: 10px;
+        margin-bottom: 10px;
+    }
+    .metric-label {
+        font-size: 14px;
+        color: #555;
+        margin-bottom: 5px;
+    }
+    .metric-value {
+        font-size: 24px;
+        font-weight: bold;
+        color: #0066cc;
+    }
+    </style>
+    """

functions.py

@@ -1,53 +1,248 @@
-def calculate_monthly_tax(monthly_income):
-    annual_income = monthly_income * 12
-    tax_brackets = [
-        (0, 600000, 0),
-        (600000, 1200000, 0.05),
-        (1200000, 2200000, 0.15),
-        (2200000, 3200000, 0.25),
-        (3200000, 4100000, 0.30),
-        (4100000, float("inf"), 0.35),
-    ]
-    total_tax = 0
-    remaining_income = annual_income
-    for lower, upper, rate in tax_brackets:
-        if remaining_income <= 0:
-            break
-
-        taxable_amount = min(remaining_income, upper - lower)
-        tax = taxable_amount * rate
-        total_tax += tax
-        remaining_income -= taxable_amount
-    monthly_tax = total_tax / 12
-    return round(monthly_tax, 2)
-
-
-def calculate_net_salary(gross_salary):
-    return gross_salary - calculate_monthly_tax(gross_salary)
-
-
-def calculated_initial_desired_net(
-    current_salary, desired_increment, daily_cost_of_travel, physical_days_per_week
-):
-    return (current_salary + current_salary * desired_increment) + (
-        daily_cost_of_travel * physical_days_per_week * 4.5
-    )
-
-
-def calculate_additional_amount(initial_desired_net):
-    gross_salary = initial_desired_net
-    max_iterations = 100
-    for _ in range(max_iterations):
-        net_salary = calculate_net_salary(gross_salary)
-        if abs(net_salary - initial_desired_net) < 0.01:
-            break
-        gross_salary += initial_desired_net - net_salary
-    additional_amount = gross_salary - initial_desired_net
-
-    return {
-        "initial_desired_net": round(initial_desired_net, 2),
-        "gross_salary_needed": round(gross_salary, 2),
-        "additional_amount": round(additional_amount, 2),
-        "tax": round(calculate_monthly_tax(gross_salary), 2),
-        "final_net_salary": round(calculate_net_salary(gross_salary), 2),
-    }
+from constants import Styles, Constants
+import streamlit as st
+
+
+class Functions:
+    @staticmethod
+    def calculate_monthly_tax(monthly_income, tax_brackets):
+        annual_income = monthly_income * 12
+        total_tax = 0
+        remaining_income = annual_income
+        for lower, upper, rate in tax_brackets:
+            if remaining_income <= 0:
+                break
+            taxable_amount = min(remaining_income, upper - lower)
+            tax = taxable_amount * rate
+            total_tax += tax
+            remaining_income -= taxable_amount
+        monthly_tax = total_tax / 12
+        return round(monthly_tax, 2)
+
+    @staticmethod
+    def calculate_net_salary(gross_salary, tax_brackets):
+        return gross_salary - Functions.calculate_monthly_tax(
+            gross_salary, tax_brackets
+        )
+
+    @staticmethod
+    def calculated_initial_desired_net(
+        current_salary, desired_increment, daily_cost_of_travel, physical_days_per_week
+    ):
+        return (current_salary + current_salary * desired_increment) + (
+            daily_cost_of_travel * physical_days_per_week * 4.5
+        )
+
+    @staticmethod
+    def calculate_additional_amount(initial_desired_net, tax_brackets):
+        gross_salary = initial_desired_net
+        max_iterations = 100
+        for _ in range(max_iterations):
+            net_salary = Functions.calculate_net_salary(gross_salary, tax_brackets)
+            if abs(net_salary - initial_desired_net) < 0.01:
+                break
+            gross_salary += initial_desired_net - net_salary
+        additional_amount = gross_salary - initial_desired_net
+
+        return {
+            "initial_desired_net": round(initial_desired_net, 2),
+            "gross_salary_needed": round(gross_salary, 2),
+            "additional_amount": round(additional_amount, 2),
+            "tax": round(
+                Functions.calculate_monthly_tax(gross_salary, tax_brackets), 2
+            ),
+            "final_net_salary": round(
+                Functions.calculate_net_salary(gross_salary, tax_brackets), 2
+            ),
+        }
+
+
+import pandas as pd
+
+
+class StreamlitFunctions:
+    @staticmethod
+    def check_initial_salary_parameter():
+        if (
+            st.session_state.user_initial_desired_net > 0
+            and st.session_state.user_initial_desired_net
+            <= st.session_state.current_salary
+        ):
+            st.warning(
+                "⚠️ The Initial Desired Net Salary should be greater than your Current Salary. Please adjust your input or leave it at 0 to calculate automatically."
+            )
+            st.session_state.valid_input = False
+        else:
+            st.session_state.valid_input = True
+
+    @staticmethod
+    def update_initial_salary_parameter():
+        if (
+            st.session_state.user_initial_desired_net_state
+            < st.session_state.current_salary
+        ):
+            st.session_state.user_initial_desired_net = (
+                st.session_state.current_salary
+                + st.session_state.user_initial_desired_net_state
+            )
+        else:
+            st.session_state.user_initial_desired_net = (
+                st.session_state.user_initial_desired_net_state
+            )
+
+    @staticmethod
+    def reset_initial_salary_parameter():
+        def reset_values():
+            st.session_state.user_initial_desired_net = Constants.DEFAULT_INITIAL_NET
+            st.session_state.valid_input = True
+
+        st.button(
+            "Reset Final Desired Net Salary Value",
+            on_click=reset_values,
+            use_container_width=True,
+        )
+
+    @staticmethod
+    def initial_salary_parameter():
+        st.header("Calculation based on Final Desired Net Salary")
+        if st.session_state.user_initial_desired_net >= st.session_state.current_salary:
+            minimum_value = st.session_state.current_salary
+        else:
+            minimum_value = 0.0
+        st.number_input(
+            "Final Desired Net Salary (PKR, optional)",
+            min_value=minimum_value,
+            value=st.session_state.user_initial_desired_net,
+            step=1000.0,
+            key="user_initial_desired_net_state",
+            on_change=StreamlitFunctions.update_initial_salary_parameter,
+        )
+
+    @staticmethod
+    def reset_tax_brackets():
+        def reset_values():
+            st.session_state.tax_brackets = Constants.DEFAULT_TAX_BRACKETS
+
+        st.button(
+            "Reset Tax Brackets",
+            use_container_width=True,
+            on_click=reset_values,
+        )
+
+    @staticmethod
+    def reset_salary_parameters():
+        def reset_values():
+            st.session_state.current_salary = Constants.DEFAULT_CURRENT_SALARY
+            st.session_state.desired_increment_percentage = (
+                Constants.DEFAULT_INCREMENT_PERCENTAGE
+            )
+            st.session_state.daily_cost_of_travel = Constants.DEFAULT_DAILY_TRAVEL_COST
+            st.session_state.physical_days_per_week = Constants.DEFAULT_PHYSICAL_DAYS
+
+        st.button(
+            "Reset Salary Parameters Values",
+            use_container_width=True,
+            on_click=reset_values,
+        )
+
+    @staticmethod
+    def print_salary_parameters():
+        st.header("Calculation Based on Salary Parameters")
+
+        def update_current_salary_parameter():
+            st.session_state.current_salary = st.session_state.current_salary_state
+
+        st.session_state.current_salary = st.number_input(
+            "Current monthly salary (PKR)",
+            min_value=0.0,
+            step=1000.0,
+            value=st.session_state.current_salary,
+            key="current_salary_state",
+            on_change=update_current_salary_parameter,
+        )
+
+        def update_desired_increment_percentage_parameter():
+            st.session_state.desired_increment_percentage = (
+                st.session_state.desired_increment_percentage_state
+            )
+
+        st.session_state.desired_increment_percentage = st.number_input(
+            "Desired salary increment (as a decimal)",
+            min_value=0.0,
+            step=0.05,
+            value=st.session_state.desired_increment_percentage,
+            format="%.2f",
+            key="desired_increment_percentage_state",
+            on_change=update_desired_increment_percentage_parameter,
+        )
+
+        def update_daily_cost_of_travel_parameter():
+            st.session_state.daily_cost_of_travel = (
+                st.session_state.daily_cost_of_travel_state
+            )
+
+        st.session_state.daily_cost_of_travel = st.number_input(
+            "Daily cost of travel (PKR)",
+            min_value=0,
+            step=100,
+            value=st.session_state.daily_cost_of_travel,
+            key="daily_cost_of_travel_state",
+            on_change=update_daily_cost_of_travel_parameter,
+        )
+
+        def update_physical_days_per_week_parameter():
+            st.session_state.physical_days_per_week = (
+                st.session_state.physical_days_per_week_state
+            )
+
+        st.session_state.physical_days_per_week = st.number_input(
+            "Number of On-Site days per week",
+            min_value=0,
+            max_value=7,
+            step=1,
+            value=st.session_state.physical_days_per_week,
+            key="physical_days_per_week_state",
+            on_change=update_physical_days_per_week_parameter,
+        )
+
+    @staticmethod
+    def print_tax_brackets():
+        st.header("Tax Brackets")
+        tax_brackets_df = pd.DataFrame(
+            st.session_state.tax_brackets,
+            columns=["Lower Limit", "Upper Limit", "Tax Rate"],
+        )
+        edited_tax_brackets = st.data_editor(tax_brackets_df, num_rows="dynamic")
+        st.session_state.tax_brackets = list(
+            edited_tax_brackets.itertuples(index=False, name=None)
+        )
+
+    @staticmethod
+    def initialize_session_values():
+        st.title("Net Salary Calculator")
+        if "tax_brackets" not in st.session_state:
+            st.session_state.tax_brackets = Constants.DEFAULT_TAX_BRACKETS
+        if "current_salary" not in st.session_state:
+            st.session_state.current_salary = Constants.DEFAULT_CURRENT_SALARY
+        if "desired_increment_percentage" not in st.session_state:
+            st.session_state.desired_increment_percentage = (
+                Constants.DEFAULT_INCREMENT_PERCENTAGE
+            )
+        if "daily_cost_of_travel" not in st.session_state:
+            st.session_state.daily_cost_of_travel = Constants.DEFAULT_DAILY_TRAVEL_COST
+        if "physical_days_per_week" not in st.session_state:
+            st.session_state.physical_days_per_week = Constants.DEFAULT_PHYSICAL_DAYS
+        if "user_initial_desired_net" not in st.session_state:
+            st.session_state.user_initial_desired_net = Constants.DEFAULT_INITIAL_NET
+
+    @staticmethod
+    def custom_metric(label, value):
+        st.markdown(Styles.METRIC_STYLE, unsafe_allow_html=True)
+        st.markdown(
+            f"""
+        <div class="metric-container">
+            <div class="metric-label">{label}</div>
+            <div class="metric-value">PKR {value:,.2f}</div>
+        </div>
+        """,
+            unsafe_allow_html=True,
+        )

salary_calculator.py

@@ -1,10 +1,16 @@
-import typer
 from typing import Optional
 
-from functions import calculated_initial_desired_net, calculate_additional_amount
+import typer
+import pandas as pd
+from constants import Constants
+from functions import Functions
 
 app = typer.Typer()
 
+tax_brackets_df = pd.DataFrame(
+    Constants.DEFAULT_TAX_BRACKETS, columns=["Lower Limit", "Upper Limit", "Tax Rate"]
+)
+
 
 @app.command()
 def calculate_salary(
@@ -22,10 +28,13 @@ def calculate_salary(
     """
     Calculate the additional amount needed for desired salary after tax adjustment.
     """
-    initial_desired_net = calculated_initial_desired_net(
-        current_salary, desired_increment_percentage, daily_cost_of_travel, physical_days_per_week
+    initial_desired_net = Functions.calculated_initial_desired_net(
+        current_salary,
+        desired_increment_percentage,
+        daily_cost_of_travel,
+        physical_days_per_week,
     )
-    result = calculate_additional_amount(initial_desired_net)
+    result = Functions.calculate_additional_amount(initial_desired_net, tax_brackets_df)
 
     typer.echo("Salary Calculation Results")
     typer.echo("--------------------------")