Skip to main content

ReadTheDocs PyPI [license][license]

Amortizer - Simple loan amortization calculator

Amortizer is a simple amortization table generator which supports two common approaches: annuity payments and straight amortization.

Overview

Amortizer is basically a single python class which instantiates an object with several useful methods.

Method Description
.get_summary(method="annuity") Calculates amortization dataframe (methods: 'straight' or 'annuity') and returns a dictionary with summary statistics.
.straight_amortization() Calculates amortization table with straight amortization and returns a dataframe.
.annuity_amortization() Calculates amortization table with annuity payments and returns a dataframe.
.to_html(method="annuity") Calculates amortization dataframe (methods: 'straight' or 'annuity') and returns results to a string with html markup.
.to_json(method="annuity") Calculates amortization dataframe (methods: 'straight' or 'annuity') and returns results to a string with JSON object.
.to_csv(path: str, method="annuity") Calculates amortization dataframe (methods: 'straight' or 'annuity') and exports results to the .csv file.

Learn more about the methods above in the Documentation

Installation

Amortizer supports python3.7 + environments.

$ pip install --upgrade amortize

or use pipenv

$ pipenv install --upgrade amortize

Getting Started

Minimal Example

from amortizer.generator import Amortizer

# Instantiate new object with any suitable name and pass itinial parameters of the loan / mortgage
amortizer = Amortizer(amount=100000, period=18, interest_rate=6)

# Get summary statistics with annuity payments
amortizer.get_summary(method="annuity")
# >>> {'total_cost': 104817.06, 'average_interest_exp': 267.62, 'average_monthly_pmt': 5823.17, 'total_interest_exp': 4817.12}

# Export amortization payments table to csv file
amortizer.to_csv(path="/tmp/", method="straight")
#>>> Data was recorded to straight_amortization.csv at the following location: /tmp/

Resources

Contributing

Feel free to send merge requests.

If you've got questions

  1. Read the docs.
  2. Look through the issues.

License

MIT License.

Metadata

Release files for amortizer 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for amortizer 0.0.4
File Size Uploaded
amortizer-0.0.4.tar.gz 5.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for amortizer 0.0.4
File Interpreter ABI Platform
amortizer-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 11.2 kB

Release files / amortizer-0.0.4.tar.gz

Download URL amortizer-0.0.4.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
94a64cd1eb2c42bb7ade132473a7418585634d953a86501e62538ff8ccead45b
BLAKE2b-256 checksum
How to use checksums
a450035fbefa6ccd3554528024163253ef8676f5f99f2512b7372f7736abad71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

Release files / amortizer-0.0.4-py3-none-any.whl

Download URL amortizer-0.0.4-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c60bf45d6eb09276eafb8c288296bc4106369af19cac2d8dca82347811868cee
BLAKE2b-256 checksum
How to use checksums
f070332fd5053139ac1e26bd72b45f0697b11ce1119fdce76914734e90df0fdd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page