Skip to main content

A package for calculating mortgage data and cash flows

Project description

Description

mortgage-boi is a python package for calculating monthly mortgage cash flows.

Usage

pip install mortgage-boi

...

import mortgage_boi as mbm
mortgage = mbm.Mortgage(principal=100_000, apr=0.06)

# monthly CF data
mortgage.payments

# specific monthly CF data
mortgage.payments_interest

Appendix

Creating a build

First, update the version number in setup.py.

Then, in the root folder:

python setup.py sdist bdist_wheel

In the root folder:

Uploading a build

Prod: python -m twine upload dist/*

Test: python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Installing the package

See https://packaging.python.org/tutorials/packaging-projects/

Useful information for building packages:

Running test suite

python -m unittest discover tests

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 mortgage-boi, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size mortgage_boi-0.0.4-py3-none-any.whl (4.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mortgage-boi-0.0.4.tar.gz (2.5 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