amortization-report / README.md
alidenewade's picture
Update README.md
7f01229 verified
---
title: Amortization Report
emoji: πŸ“Š
colorFrom: pink
colorTo: purple
sdk: gradio
app_file: app.py
pinned: false
license: mit
sdk_version: 5.29.1
---
# πŸ“Š Amortization Report
This interactive app helps you generate a full amortization schedule for any loan. Simply enter your loan amount, interest rate, and loan period, and you'll get:
- A detailed amortization table
- A breakdown of interest and principal paid per year
- A line chart showing remaining balance over time
Built with Python, Gradio, NumPy Financial, Pandas, and Matplotlib β€” and hosted on Hugging Face Spaces.
---
## πŸ”’ How It Works
**Input Parameters:**
- **Loan Amount (Principal)** – Total amount borrowed
- **Annual Interest Rate (%)** – Input as a percentage (e.g., type `5` for 5%)
- **Number of Periods (Years)** – Duration of the loan in years
**Output:**
- πŸ“‹ **Amortization Table** showing payment, interest, principal, and balance per year
- πŸ“ˆ **Payment Breakdown Plot** comparing interest and principal over time
- πŸ“‰ **Remaining Balance Chart** showing how your debt is paid off
---
## πŸ§ͺ Example
Try entering the following:
- Loan Amount (Principal): 100000
- Annual Interest Rate (%): 5.00
- Number of Periods (Years): 10
You’ll see how the loan amortizes β€” how much you pay in interest and principal each year, and how the balance decreases over time.
---
## πŸ“¦ Installation
Clone the repo and install the required packages:
```bash
git clone https://huggingface.co/spaces/ali-denewade/amortization-report
cd amortization-report
pip install -r requirements.txt