Skip to main content

Python library for mortgage calculations.

Project description

# py-mortgagekit
## Build Status
[![Build Status](https://travis-ci.org/MikaSoftware/py-mortgagekit.svg?branch=master)](https://travis-ci.org/MikaSoftware/py-mortgagekit)
[![PyPI version fury.io](https://badge.fury.io/py/py-mortgagekit.svg)](https://pypi.python.org/pypi/py-mortgagekit)
[![Coverage Status](https://coveralls.io/repos/github/MikaSoftware/py-mortgagekit/badge.svg?branch=master)](https://coveralls.io/github/MikaSoftware/py-mortgagekit?branch=master)

## Description
Python library for mortgage calculations.

## Installation
### Requirements
* Python 3.6++

### Instructions
```bash
pip instll py-mortgagekit
```

## Usage
### Development
Here is an example of using the using the library in your code.

```python
from mortgagekit.constants import *
from mortgagekit.calculator import *

# Define our variables.
total_amount = Money(amount=250000.00, currency="USD")
down_payment = Money(amount=50000.00, currency="USD")
amortization_year = 25
annual_interest_rate = Decimal(0.04)
payment_frequency = MORTGAGEKIT_MONTH # see calculator.py for more options.
compounding_period = MORTGAGEKIT_SEMI_ANNUAL
first_payment_date = '2008-01-01'

# Feel free to use an alternate currency type by first checking to see if your
# your currency is supported here:
# https://github.com/limist/py-moneyed/blob/master/moneyed/localization.py#L348
currency='USD'

# Load up our calculator.
calc = MortgageCalculator(total_amount, down_payment, amortization_year,
annual_interest_rate, payment_frequency, compounding_period,
first_payment_date, currency)

# Perform computations.
payment_schedule = calc.mortgage_payment_schedule()

# You can now inspect the results and use it for your purposes.
print(payment_schedule)
```

### Quality Assurance
#### Unit Tests
If you want to run the unit tests, you can run the following.

Here is how you run the unit tests.

```bash
python setup.py test
```

#### Code Coverage
Here is how you run code coverage. The first command runs the code coverage
and the second command provides a report. If you would like to know more about ``coverage`` then click to [here to read](http://coverage.readthedocs.io/en/latest/).

```bash
coverage run --source=mortgagekit setup.py test
coverage report -m
```

## License
This library is licensed under the **BSD** license. See [LICENSE.md](LICENSE.md) for more information.


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-mortgagekit, version 1.0.3b1
Filename, size File type Python version Upload date Hashes
Filename, size py_mortgagekit-1.0.3b1-py2.py3-none-any.whl (8.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size py-mortgagekit-1.0.3b1.tar.gz (5.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page