Skip to main content

A package to handle mortgage calculations

Project description

Py-Mortgage

To install:

pip install py_mortgage

To access Mortgage object

import py_mortgage as pym
new_mortgage = pym.mortgage.Mortgage(rate=.04/12,term=360,loan=400000)

py_mortgage has the following methods:

  1. Mortgage.get_pmt(): Will return the payment per period

  2. Mortgage.get_pmt(period): Will return all payments paid up to and including period

  3. Mortgage.get_amortization_table(format='pandas_df', decimal_places=2): Will return an amortization table per period. If format = 'pandas_df', it will return a Pandas DataFrame. If format = 'json', it will convert the DataFrame to a JSON object. Decimal places defaults to 2.

  4. Mortgage.get_interest_pmt(period): Will return the total interest paid in period

  5. Mortgage.get_principal_pmt(period): Will return the total principal paid down in period

  6. Mortgage.cumulative_interest_pmt(period): Will return all interest paid up to and including period.

  7. Mortgage.cumulative_principal_pmt(period): Will return all principal paid up to and including period.

  8. Mortgage.remaining_mortgage_balance(ending_period): Will return the remaining principal up to and including ending_period

  9. Mortgage.describe(): Will return fields from Mortgage

Mortgage.get_apr() is not completed yet and will be included in next release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for py-mortgage, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size py_mortgage-0.2.2-py3-none-any.whl (4.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size py_mortgage-0.2.2.tar.gz (3.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page