alidenewade commited on
Commit
285c75e
Β·
verified Β·
1 Parent(s): e88ec06

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +52 -0
README.md CHANGED
@@ -8,3 +8,55 @@ app_file: app.py
8
  pinned: false
9
  license: mit
10
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  pinned: false
9
  license: mit
10
  ---
11
+
12
+ # πŸ“Š Amortization Report
13
+
14
+ 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:
15
+
16
+ - A detailed amortization table
17
+ - A breakdown of interest and principal paid per year
18
+ - A line chart showing remaining balance over time
19
+
20
+ Built with Python, Gradio, NumPy Financial, Pandas, and Matplotlib β€” and hosted on Hugging Face Spaces.
21
+
22
+ ---
23
+
24
+ ## πŸ”’ How It Works
25
+
26
+ **Input Parameters:**
27
+
28
+ - **Loan Amount (Principal)** – Total amount borrowed
29
+ - **Annual Interest Rate (%)** – Input as a percentage (e.g., type `5` for 5%)
30
+ - **Number of Periods (Years)** – Duration of the loan in years
31
+
32
+ **Output:**
33
+
34
+ - πŸ“‹ **Amortization Table** showing payment, interest, principal, and balance per year
35
+ - πŸ“ˆ **Payment Breakdown Plot** comparing interest and principal over time
36
+ - πŸ“‰ **Remaining Balance Chart** showing how your debt is paid off
37
+
38
+ ---
39
+
40
+ ## πŸ§ͺ Example
41
+
42
+ Try entering the following:
43
+
44
+ - Loan Amount (Principal): 100000
45
+ - Annual Interest Rate (%): 5.00
46
+ - Number of Periods (Years): 10
47
+
48
+
49
+ You’ll see how the loan amortizes β€” how much you pay in interest and principal each year, and how the balance decreases over time.
50
+
51
+ ---
52
+
53
+ ## πŸ“¦ Installation
54
+
55
+ Clone the repo and install the required packages:
56
+
57
+ ```bash
58
+ git clone https://huggingface.co/spaces/ali-denewade/amortization-report
59
+ cd amortization-report
60
+ pip install -r requirements.txt
61
+
62
+