amortizer 0.0.4

Simple package for generating loan amortization table and summary

[][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

• PyPi
• Documentation
• Issue tracking

Contributing

Feel free to send merge requests.

If you've got questions

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

License

MIT License.