adding file to the repo

.gitignore

@@ -0,0 +1,106 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.idea

functions.py

@@ -0,0 +1,53 @@
+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),
+    }

readme.md

@@ -0,0 +1,55 @@
+# Salary Calculator
+
+This Salary Calculator is a Python-based command-line tool designed to help users determine the additional amount needed on top of their desired salary to account for taxes. It takes into consideration factors such as current salary, desired increment, daily travel costs, and the number of physical workdays per week.
+
+## Getting Started
+
+### A. Prerequisites
+
+- Conda environment manager
+- Python version 3.11
+
+### B. Setting Up the Environment
+
+1. **Create and activate a Conda environment**:
+   - Create: `conda create -n salary_calc_env python=3.11 -y`
+   - Activate: `conda activate salary_calc_env`
+   - **Note**: You can replace `salary_calc_env` with your preferred environment name.
+
+2. **Install required packages**: 
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+### C. Running the Application
+
+- Using default values:
+  ```bash
+  python salary_calculator.py 90000
+  ```
+  This uses default values of `desired_increment_percentage=0.3`, `daily_cost_of_travel=1500`, and `physical_days_per_week=5`.
+
+- Using custom values:
+  ```bash
+  python salary_calculator.py 220000 --desired-increment-percentage 0.10 --daily-cost-of-travel 2000 --physical-days-per-week 3
+  ```
+F
+- For help and to see all available options:
+  ```bash
+  python salary_calculator.py --help
+  ```
+
+## Features
+
+- Calculates the additional amount needed to achieve the desired net salary after tax deductions
+- Considers factors like current salary, desired increment, daily travel costs, and work schedule
+- Provides a detailed breakdown of the calculation results
+- Offers flexibility to use default values or specify custom inputs
+
+## Contributing
+
+Feel free to fork this project and submit pull requests with any enhancements or bug fixes. For major changes, please open an issue first to discuss the proposed changes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

requirements.txt

@@ -0,0 +1 @@
+typer==0.12.3

salary_calculator.py

@@ -0,0 +1,46 @@
+import typer
+from typing import Optional
+
+from functions import calculated_initial_desired_net, calculate_additional_amount
+
+app = typer.Typer()
+
+
+@app.command()
+def calculate_salary(
+    current_salary: int = typer.Argument(..., help="Current monthly salary in PKR"),
+    desired_increment_percentage: Optional[float] = typer.Option(
+        0.3, help="Desired salary increment as a decimal (e.g., 0.3 for 30%)"
+    ),
+    daily_cost_of_travel: Optional[int] = typer.Option(
+        1500, help="Daily cost of travel in PKR"
+    ),
+    physical_days_per_week: Optional[int] = typer.Option(
+        5, help="Number of physical days per week"
+    ),
+):
+    """
+    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
+    )
+    result = calculate_additional_amount(initial_desired_net)
+
+    typer.echo("Salary Calculation Results")
+    typer.echo("--------------------------")
+    typer.echo(
+        f"{'Initial Desired Net Salary':<30} PKR {result['initial_desired_net']:>13,.2f}"
+    )
+    typer.echo(
+        f"{'Gross Salary Needed':<30} PKR {result['gross_salary_needed']:>13,.2f}"
+    )
+    typer.echo(
+        f"{'Additional Amount Needed':<30} PKR {result['additional_amount']:>13,.2f}"
+    )
+    typer.echo(f"{'Tax':<30} PKR {result['tax']:>13,.2f}")
+    typer.echo(f"{'Final Net Salary':<30} PKR {result['final_net_salary']:>13,.2f}")
+
+
+if __name__ == "__main__":
+    app()