{ "info": { "author": "Bartlomiej Mika", "author_email": "bart@mikasoftware.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Education", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Programming Language :: Python :: 3.6", "Topic :: Office/Business :: Financial :: Accounting" ], "description": "# py-mortgagekit\n## Build Status\n[![Build Status](https://travis-ci.org/MikaSoftware/py-mortgagekit.svg?branch=master)](https://travis-ci.org/MikaSoftware/py-mortgagekit)\n[![PyPI version fury.io](https://badge.fury.io/py/py-mortgagekit.svg)](https://pypi.python.org/pypi/py-mortgagekit)\n[![Coverage Status](https://coveralls.io/repos/github/MikaSoftware/py-mortgagekit/badge.svg?branch=master)](https://coveralls.io/github/MikaSoftware/py-mortgagekit?branch=master)\n\n## Description\nPython library for mortgage calculations.\n\n## Installation\n### Requirements\n* Python 3.6++\n\n### Instructions\n ```bash\n pip instll py-mortgagekit\n ```\n\n## Usage\n### Development\nHere is an example of using the using the library in your code.\n\n ```python\n from mortgagekit.constants import *\n from mortgagekit.calculator import *\n\n # Define our variables.\n total_amount = Money(amount=250000.00, currency=\"USD\")\n down_payment = Money(amount=50000.00, currency=\"USD\")\n amortization_year = 25\n annual_interest_rate = Decimal(0.04)\n payment_frequency = MORTGAGEKIT_MONTH # see calculator.py for more options.\n compounding_period = MORTGAGEKIT_SEMI_ANNUAL\n first_payment_date = '2008-01-01'\n\n # Feel free to use an alternate currency type by first checking to see if your\n # your currency is supported here:\n # https://github.com/limist/py-moneyed/blob/master/moneyed/localization.py#L348\n currency='USD'\n\n # Load up our calculator.\n calc = MortgageCalculator(total_amount, down_payment, amortization_year,\n annual_interest_rate, payment_frequency, compounding_period,\n first_payment_date, currency)\n\n # Perform computations.\n payment_schedule = calc.mortgage_payment_schedule()\n\n # You can now inspect the results and use it for your purposes.\n print(payment_schedule)\n ```\n\n### Quality Assurance\n#### Unit Tests\nIf you want to run the unit tests, you can run the following.\n\nHere is how you run the unit tests.\n\n```bash\npython setup.py test\n```\n\n#### Code Coverage\nHere is how you run code coverage. The first command runs the code coverage\nand 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/).\n\n```bash\ncoverage run --source=mortgagekit setup.py test\ncoverage report -m\n```\n\n## License\nThis library is licensed under the **BSD** license. See [LICENSE.md](LICENSE.md) for more information.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/MikaSoftware/py-mortgagekit", "keywords": "mortgage amortization finance", "license": "BSD 2-Clause License", "maintainer": "", "maintainer_email": "", "name": "py-mortgagekit", "package_url": "https://pypi.org/project/py-mortgagekit/", "platform": "", "project_url": "https://pypi.org/project/py-mortgagekit/", "project_urls": { "Homepage": "https://github.com/MikaSoftware/py-mortgagekit" }, "release_url": "https://pypi.org/project/py-mortgagekit/1.0.3b1/", "requires_dist": [ "py-moneyed", "python-dateutil" ], "requires_python": ">=3.6", "summary": "Python library for mortgage calculations.", "version": "1.0.3b1" }, "last_serial": 3323822, "releases": { "1.0.3b1": [ { "comment_text": "", "digests": { "md5": "20d97c914f6ffac5e43f9fc386fe0027", "sha256": "0377195f7e7a054ac9604ea21f3f73141a41ea946bf5c8dda26d8732e5324b56" }, "downloads": -1, "filename": "py_mortgagekit-1.0.3b1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "20d97c914f6ffac5e43f9fc386fe0027", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 8337, "upload_time": "2017-11-11T03:18:50", "url": "https://files.pythonhosted.org/packages/2d/18/a2e06e82ddb7659b76d0f7008b04fdc1000cf7aa8d26351611c1310f79f1/py_mortgagekit-1.0.3b1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3d27de2ceaf67eec737d033109d52be4", "sha256": "b5dc75d93ee4e9404fe43893c2647d82a86612af0fa485db031db5d6c8265090" }, "downloads": -1, "filename": "py-mortgagekit-1.0.3b1.tar.gz", "has_sig": false, "md5_digest": "3d27de2ceaf67eec737d033109d52be4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 5116, "upload_time": "2017-11-11T03:18:52", "url": "https://files.pythonhosted.org/packages/2a/7e/40c05b074d3d0533e20b663e5b9ddd04d4281d37e1aa66c78c644083b159/py-mortgagekit-1.0.3b1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "20d97c914f6ffac5e43f9fc386fe0027", "sha256": "0377195f7e7a054ac9604ea21f3f73141a41ea946bf5c8dda26d8732e5324b56" }, "downloads": -1, "filename": "py_mortgagekit-1.0.3b1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "20d97c914f6ffac5e43f9fc386fe0027", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 8337, "upload_time": "2017-11-11T03:18:50", "url": "https://files.pythonhosted.org/packages/2d/18/a2e06e82ddb7659b76d0f7008b04fdc1000cf7aa8d26351611c1310f79f1/py_mortgagekit-1.0.3b1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3d27de2ceaf67eec737d033109d52be4", "sha256": "b5dc75d93ee4e9404fe43893c2647d82a86612af0fa485db031db5d6c8265090" }, "downloads": -1, "filename": "py-mortgagekit-1.0.3b1.tar.gz", "has_sig": false, "md5_digest": "3d27de2ceaf67eec737d033109d52be4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 5116, "upload_time": "2017-11-11T03:18:52", "url": "https://files.pythonhosted.org/packages/2a/7e/40c05b074d3d0533e20b663e5b9ddd04d4281d37e1aa66c78c644083b159/py-mortgagekit-1.0.3b1.tar.gz" } ] }