Welcome to mortgage_calc documentation!

This library contains classes that can be used to calculate various attributes of a fully amoratirized mortgage to include the monthly mortgage value, Private Mortgage Insurance (PMI), property or real estage insurance, taxes, and other metrics.

Contents:

• mortgage
  • Mortgage
  • Affordable Home Value

Indices and tables

• Index

• Module Index

• Search Page

Installation

In order to download this repository from github follow these instructions.

1. Install poetry globally on your computer. Follow the instructions from the Poetry website

2. Set the poetry virtual environment with the following command poetry config virtualenvs.in-project true

3. Ensure you have .git installed on your computer.

4. Open a terminal (Bash, zsh or DOS) and cd to the directory where you want to install the cobralib library

5. Type git clone https://github.com/Jon-Webb-79/mortgage-calc.git

6. cd into the cobralib directory

7. cd into the cobralib directory

8. Create a virtual environment with the command python3 -m venv .venv

9. Activate the virtual environment with the command source .venv/bin/activate

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to include and update tests as well as relevant cod-strings and sphinx updates.

License

This project uses a basic MIT license