Metadata-Version: 1.1
Name: mortgage
Version: 1.0.0
Summary: Mortgage Calculator
Home-page: https://github.com/austinmcconnell/mortgage
Author: Austin McConnell
Author-email: austin.s.mcconnell@gmail.com
License: MIT license
Description: Mortgage
        ====================
        
        [![Travis][travis_logo]][travis_link] [![Codecov][codecov_logo]][codecov_link] [![Pyup][pyup_logo]][pyup_link]
        
        [travis_logo]: https://img.shields.io/travis/austinmcconnell/mortgage.svg
        [travis_link]: https://travis-ci.org/austinmcconnell/mortgage
        [codecov_logo]: https://img.shields.io/codecov/c/github/austinmcconnell/mortgage.svg
        [codecov_link]: https://codecov.io/gh/austinmcconnell/mortgage
        [pyup_logo]: https://pyup.io/repos/github/austinmcconnell/mortgage/shield.svg
        [pyup_link]: https://pyup.io/repos/github/austinmcconnell/mortgage/
        
        Simple mortgage calculator tool
        
        
        Installation
        --------------------
        
        To install mortgage, simply:
        
        ```commandline
        pip install mortgage
        ```
        
        How To Use
        --------------------
        
        This package is intended to help understand the true cost of a mortgage. It also can help you easily compare between different mortgages.
         
        Begin by importing the loan class
        
        ```python
        from mortgage import Loan
        
        ``` 
        
        Create a simple mortgage
        
        ```python
        loan = Loan(principal=200000, interest=.06, term=30, start_date=(2017,3,1))
        ```
        
        View a summary of pertinent mortgage information by calling the summarize property.
        
        ```python
        loan.summarize
        
        >>> Original Balance:         $    200,000
        >>> Interest Rate:                    0.06 %
        >>> APY:                              6.17 %
        >>> APR:                              6.00 %
        >>> Term:                               30 years
        >>> Monthly Payment:          $    1199.10
        
        >>> Total principal payments: $ 200,000.00
        >>> Total interest payments:  $ 231,676.38
        >>> Total payments:           $ 431,676.38
        >>> Interest to principal:           115.8 %
        >>> Years to pay:                     30.0
        ```
        
        
        Run The Test Cases
        --------------------
        From the top level directory, run the following command:
        
        ```
        pytest
        ```
        
        Thank You
        --------------------
        
        Thanks for checking out the package! I hope you find it useful.
        
        Feel free to open an issue with suggestions, imporovements, ideas, etc.
        
Keywords: mortgage
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
