<table>
<tr>
<td>License</td>
<td><img src='https://img.shields.io/pypi/l/amortization.svg?style=for-the-badge' alt="License"></td>
<td>Version</td>
<td><img src='https://img.shields.io/pypi/v/amortization.svg?logo=pypi&style=for-the-badge' alt="Version"></td>
</tr>
<tr>
<td>Github Actions</td>
<td><img src='https://img.shields.io/github/actions/workflow/status/roniemartinez/amortization/python.yml?branch=master&label=actions&logo=github%20actions&style=for-the-badge' alt="Github Actions"></td>
<td>Coverage</td>
<td><img src='https://img.shields.io/codecov/c/github/roniemartinez/amortization/master?label=codecov&logo=codecov&style=for-the-badge' alt="CodeCov"></td>
</tr>
<tr>
<td>Supported versions</td>
<td><img src='https://img.shields.io/pypi/pyversions/amortization.svg?logo=python&style=for-the-badge' alt="Python Versions"></td>
<td>Wheel</td>
<td><img src='https://img.shields.io/pypi/wheel/amortization.svg?style=for-the-badge' alt="Wheel"></td>
</tr>
<tr>
<td>Status</td>
<td><img src='https://img.shields.io/pypi/status/amortization.svg?style=for-the-badge' alt="Status"></td>
<td>Downloads</td>
<td><img src='https://img.shields.io/pypi/dm/amortization.svg?style=for-the-badge' alt="Downloads"></td>
</tr>
</table>
# amortization
Python library for calculating amortizations and generating amortization schedules
## Installation
```bash
pip install amortization
```
## Usage
### Python
#### Amortization Amount
```python
from amortization.amount import calculate_amortization_amount
amount = calculate_amortization_amount(150000, 0.1, 36)
```
#### Amortization Period
```python
from amortization.period import calculate_amortization_period
period = calculate_amortization_period(150000, 0.1, 4840.08)
```
### Amortization Schedule
```python
from amortization.schedule import amortization_schedule
for number, amount, interest, principal, balance in amortization_schedule(150000, 0.1, 36):
print(number, amount, interest, principal, balance)
```
### Amortization Schedule (using tabulate)
```python
from amortization.schedule import amortization_schedule
from tabulate import tabulate
table = (x for x in amortization_schedule(150000, 0.1, 36))
print(
tabulate(
table,
headers=["Number", "Amount", "Interest", "Principal", "Balance"],
floatfmt=",.2f",
numalign="right"
)
)
```
### Command line
```bash
amortize -h
usage: amortize [-h] -P PRINCIPAL -r INTEREST_RATE [-s] [-f {daily,biweekly,weekly,semimonthly,monthly,quarterly,semiyearly,yearly}] (-n PERIOD | -a AMOUNT)
Python library for calculating amortizations and generating amortization schedules
options:
-h, --help show this help message and exit
-s, --schedule Generate amortization schedule
-f {daily,biweekly,weekly,semimonthly,monthly,quarterly,semiyearly,yearly}, --frequency {daily,biweekly,weekly,semimonthly,monthly,quarterly,semiyearly,yearly}
Payment frequency
-n PERIOD, --period PERIOD
Total number of periods
-a AMOUNT, --amount AMOUNT
Amortization amount per period
required arguments:
-P PRINCIPAL, --principal PRINCIPAL
Principal amount
-r INTEREST_RATE, --interest-rate INTEREST_RATE
Interest rate per year
```
```bash
amortize -P 150000 -n 36 -r 0.1 # period
amortize -P 150000 -n 36 -r 0.1 -s # schedule
amortize -P 150000 -a 4840.08 -r 0.1 # amount
amortize -P 150000 -n 36 -r 0.1 -f weekly # period (specify payment frequency)
```
```bash
% amortize -P 150000 -n 36 -r 0.1 -s
Number Amount Interest Principal Balance
-------- ---------- ---------- ----------- ----------
1 4,840.08 1,250.00 3,590.08 146,409.92
2 4,840.08 1,220.08 3,620.00 142,789.92
3 4,840.08 1,189.92 3,650.16 139,139.76
4 4,840.08 1,159.50 3,680.58 135,459.18
5 4,840.08 1,128.83 3,711.25 131,747.93
6 4,840.08 1,097.90 3,742.18 128,005.75
7 4,840.08 1,066.71 3,773.37 124,232.38
8 4,840.08 1,035.27 3,804.81 120,427.57
9 4,840.08 1,003.56 3,836.52 116,591.05
10 4,840.08 971.59 3,868.49 112,722.56
11 4,840.08 939.35 3,900.73 108,821.83
12 4,840.08 906.85 3,933.23 104,888.60
13 4,840.08 874.07 3,966.01 100,922.59
14 4,840.08 841.02 3,999.06 96,923.53
15 4,840.08 807.70 4,032.38 92,891.15
16 4,840.08 774.09 4,065.99 88,825.16
17 4,840.08 740.21 4,099.87 84,725.29
18 4,840.08 706.04 4,134.04 80,591.25
19 4,840.08 671.59 4,168.49 76,422.76
20 4,840.08 636.86 4,203.22 72,219.54
21 4,840.08 601.83 4,238.25 67,981.29
22 4,840.08 566.51 4,273.57 63,707.72
23 4,840.08 530.90 4,309.18 59,398.54
24 4,840.08 494.99 4,345.09 55,053.45
25 4,840.08 458.78 4,381.30 50,672.15
26 4,840.08 422.27 4,417.81 46,254.34
27 4,840.08 385.45 4,454.63 41,799.71
28 4,840.08 348.33 4,491.75 37,307.96
29 4,840.08 310.90 4,529.18 32,778.78
30 4,840.08 273.16 4,566.92 28,211.86
31 4,840.08 235.10 4,604.98 23,606.88
32 4,840.08 196.72 4,643.36 18,963.52
33 4,840.08 158.03 4,682.05 14,281.47
34 4,840.08 119.01 4,721.07 9,560.40
35 4,840.08 79.67 4,760.41 4,799.99
36 4,839.99 40.00 4,799.99 0.00
Totals 174,242.79 24,242.79 150,000.00
```
## Dependencies
[tabulate](https://bitbucket.org/astanin/python-tabulate)
## Author
[Ronie Martinez](mailto:ronmarti18@gmail.com)
## References
- [Amortization Calculation Formula](https://www.vertex42.com/ExcelArticles/amortization-calculation.html)
- [Amortization Period Formula](https://math.stackexchange.com/a/3185904)
Raw data
{
"_id": null,
"home_page": "https://github.com/roniemartinez/amortization",
"name": "amortization",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "amortization",
"author": "Ronie Martinez",
"author_email": "ronmarti18@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/84/ec/dbc3b5a1cde29c741dea869698288d675046d09042b516eb0698a5d24c74/amortization-2.4.0.tar.gz",
"platform": null,
"description": "<table>\n <tr>\n <td>License</td>\n <td><img src='https://img.shields.io/pypi/l/amortization.svg?style=for-the-badge' alt=\"License\"></td>\n <td>Version</td>\n <td><img src='https://img.shields.io/pypi/v/amortization.svg?logo=pypi&style=for-the-badge' alt=\"Version\"></td>\n </tr>\n <tr>\n <td>Github Actions</td>\n <td><img src='https://img.shields.io/github/actions/workflow/status/roniemartinez/amortization/python.yml?branch=master&label=actions&logo=github%20actions&style=for-the-badge' alt=\"Github Actions\"></td>\n <td>Coverage</td>\n <td><img src='https://img.shields.io/codecov/c/github/roniemartinez/amortization/master?label=codecov&logo=codecov&style=for-the-badge' alt=\"CodeCov\"></td>\n </tr>\n <tr>\n <td>Supported versions</td>\n <td><img src='https://img.shields.io/pypi/pyversions/amortization.svg?logo=python&style=for-the-badge' alt=\"Python Versions\"></td>\n <td>Wheel</td>\n <td><img src='https://img.shields.io/pypi/wheel/amortization.svg?style=for-the-badge' alt=\"Wheel\"></td>\n </tr>\n <tr>\n <td>Status</td>\n <td><img src='https://img.shields.io/pypi/status/amortization.svg?style=for-the-badge' alt=\"Status\"></td>\n <td>Downloads</td>\n <td><img src='https://img.shields.io/pypi/dm/amortization.svg?style=for-the-badge' alt=\"Downloads\"></td>\n </tr>\n</table>\n\n# amortization\n\nPython library for calculating amortizations and generating amortization schedules\n\n## Installation\n\n```bash\npip install amortization\n```\n\n## Usage\n\n### Python\n\n#### Amortization Amount\n\n```python\nfrom amortization.amount import calculate_amortization_amount\n\namount = calculate_amortization_amount(150000, 0.1, 36)\n```\n\n#### Amortization Period\n\n```python\nfrom amortization.period import calculate_amortization_period\n\nperiod = calculate_amortization_period(150000, 0.1, 4840.08)\n```\n\n### Amortization Schedule\n\n```python\nfrom amortization.schedule import amortization_schedule\n\nfor number, amount, interest, principal, balance in amortization_schedule(150000, 0.1, 36):\n print(number, amount, interest, principal, balance)\n```\n\n### Amortization Schedule (using tabulate)\n\n```python\nfrom amortization.schedule import amortization_schedule\nfrom tabulate import tabulate\n\ntable = (x for x in amortization_schedule(150000, 0.1, 36))\nprint(\n tabulate(\n table,\n headers=[\"Number\", \"Amount\", \"Interest\", \"Principal\", \"Balance\"],\n floatfmt=\",.2f\",\n numalign=\"right\"\n )\n)\n```\n\n### Command line\n\n```bash\namortize -h\nusage: amortize [-h] -P PRINCIPAL -r INTEREST_RATE [-s] [-f {daily,biweekly,weekly,semimonthly,monthly,quarterly,semiyearly,yearly}] (-n PERIOD | -a AMOUNT)\n\nPython library for calculating amortizations and generating amortization schedules\n\noptions:\n -h, --help show this help message and exit\n -s, --schedule Generate amortization schedule\n -f {daily,biweekly,weekly,semimonthly,monthly,quarterly,semiyearly,yearly}, --frequency {daily,biweekly,weekly,semimonthly,monthly,quarterly,semiyearly,yearly}\n Payment frequency\n -n PERIOD, --period PERIOD\n Total number of periods\n -a AMOUNT, --amount AMOUNT\n Amortization amount per period\n\nrequired arguments:\n -P PRINCIPAL, --principal PRINCIPAL\n Principal amount\n -r INTEREST_RATE, --interest-rate INTEREST_RATE\n Interest rate per year\n```\n\n```bash\namortize -P 150000 -n 36 -r 0.1 # period\namortize -P 150000 -n 36 -r 0.1 -s # schedule\namortize -P 150000 -a 4840.08 -r 0.1 # amount\namortize -P 150000 -n 36 -r 0.1 -f weekly # period (specify payment frequency)\n```\n\n```bash\n% amortize -P 150000 -n 36 -r 0.1 -s \nNumber Amount Interest Principal Balance\n-------- ---------- ---------- ----------- ----------\n1 4,840.08 1,250.00 3,590.08 146,409.92\n2 4,840.08 1,220.08 3,620.00 142,789.92\n3 4,840.08 1,189.92 3,650.16 139,139.76\n4 4,840.08 1,159.50 3,680.58 135,459.18\n5 4,840.08 1,128.83 3,711.25 131,747.93\n6 4,840.08 1,097.90 3,742.18 128,005.75\n7 4,840.08 1,066.71 3,773.37 124,232.38\n8 4,840.08 1,035.27 3,804.81 120,427.57\n9 4,840.08 1,003.56 3,836.52 116,591.05\n10 4,840.08 971.59 3,868.49 112,722.56\n11 4,840.08 939.35 3,900.73 108,821.83\n12 4,840.08 906.85 3,933.23 104,888.60\n13 4,840.08 874.07 3,966.01 100,922.59\n14 4,840.08 841.02 3,999.06 96,923.53\n15 4,840.08 807.70 4,032.38 92,891.15\n16 4,840.08 774.09 4,065.99 88,825.16\n17 4,840.08 740.21 4,099.87 84,725.29\n18 4,840.08 706.04 4,134.04 80,591.25\n19 4,840.08 671.59 4,168.49 76,422.76\n20 4,840.08 636.86 4,203.22 72,219.54\n21 4,840.08 601.83 4,238.25 67,981.29\n22 4,840.08 566.51 4,273.57 63,707.72\n23 4,840.08 530.90 4,309.18 59,398.54\n24 4,840.08 494.99 4,345.09 55,053.45\n25 4,840.08 458.78 4,381.30 50,672.15\n26 4,840.08 422.27 4,417.81 46,254.34\n27 4,840.08 385.45 4,454.63 41,799.71\n28 4,840.08 348.33 4,491.75 37,307.96\n29 4,840.08 310.90 4,529.18 32,778.78\n30 4,840.08 273.16 4,566.92 28,211.86\n31 4,840.08 235.10 4,604.98 23,606.88\n32 4,840.08 196.72 4,643.36 18,963.52\n33 4,840.08 158.03 4,682.05 14,281.47\n34 4,840.08 119.01 4,721.07 9,560.40\n35 4,840.08 79.67 4,760.41 4,799.99\n36 4,839.99 40.00 4,799.99 0.00\nTotals 174,242.79 24,242.79 150,000.00\n```\n\n## Dependencies\n\n[tabulate](https://bitbucket.org/astanin/python-tabulate)\n\n## Author\n\n[Ronie Martinez](mailto:ronmarti18@gmail.com)\n\n## References\n\n- [Amortization Calculation Formula](https://www.vertex42.com/ExcelArticles/amortization-calculation.html)\n- [Amortization Period Formula](https://math.stackexchange.com/a/3185904)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library for calculating amortizations and generating amortization schedules",
"version": "2.4.0",
"project_urls": {
"Donate": "https://www.buymeacoffee.com/roniemartinez",
"Homepage": "https://github.com/roniemartinez/amortization",
"Repository": "https://github.com/roniemartinez/amortization"
},
"split_keywords": [
"amortization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48902d04e5008745ffa726ff561357be42c997e53338ead734d4d84f1f741e16",
"md5": "30a81e2cdef8c4a44d2323bc2ddc8162",
"sha256": "7d565d0818cc5562dc4156cefe372dd2f3630631d08ac38417306216fb2ada60"
},
"downloads": -1,
"filename": "amortization-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "30a81e2cdef8c4a44d2323bc2ddc8162",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 7544,
"upload_time": "2024-05-07T20:29:48",
"upload_time_iso_8601": "2024-05-07T20:29:48.248539Z",
"url": "https://files.pythonhosted.org/packages/48/90/2d04e5008745ffa726ff561357be42c997e53338ead734d4d84f1f741e16/amortization-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "84ecdbc3b5a1cde29c741dea869698288d675046d09042b516eb0698a5d24c74",
"md5": "ba67201ea0297fd0c285ebc8a0e165ab",
"sha256": "7f4fa75a3e197e8deb2000cbe71aada7c747e3e2b628a8293d49e732c774491b"
},
"downloads": -1,
"filename": "amortization-2.4.0.tar.gz",
"has_sig": false,
"md5_digest": "ba67201ea0297fd0c285ebc8a0e165ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 5912,
"upload_time": "2024-05-07T20:29:49",
"upload_time_iso_8601": "2024-05-07T20:29:49.438256Z",
"url": "https://files.pythonhosted.org/packages/84/ec/dbc3b5a1cde29c741dea869698288d675046d09042b516eb0698a5d24c74/amortization-2.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-07 20:29:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "roniemartinez",
"github_project": "amortization",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "amortization"
}
JSON
