This release is a pre-release and may not be stable for production use.
## Build Status
[](https://travis-ci.org/MikaSoftware/py-mortgagekit)
[](https://pypi.python.org/pypi/py-mortgagekit)
[](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.
Metadata
Release files for py-mortgagekit 1.0.3b1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| py-mortgagekit-1.0.3b1.tar.gz | 5.1 kB | Without provenance | Details for py-mortgagekit-1.0.3b1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| py_mortgagekit-1.0.3b1-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for py_mortgagekit-1.0.3b1-py2.py3-none-any.whl |
Total release size: 13.5 kB
Release files / py-mortgagekit-1.0.3b1.tar.gz
| Download URL | py-mortgagekit-1.0.3b1.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5dc75d93ee4e9404fe43893c2647d82a86612af0fa485db031db5d6c8265090
|
|
BLAKE2b-256 checksum How to use checksums |
2a7e40c05b074d3d0533e20b663e5b9ddd04d4281d37e1aa66c78c644083b159
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / py_mortgagekit-1.0.3b1-py2.py3-none-any.whl
| Download URL | py_mortgagekit-1.0.3b1-py2.py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
0377195f7e7a054ac9604ea21f3f73141a41ea946bf5c8dda26d8732e5324b56
|
|
BLAKE2b-256 checksum How to use checksums |
2d18a2e06e82ddb7659b76d0f7008b04fdc1000cf7aa8d26351611c1310f79f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for py-mortgagekit 1.0.3b1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.