py-incomepropertyevaluatorkit

This library is currently being developed and is not production quality ready!

Build Status

Overview

Python library for performing rental and income property calculations.

Minimum Requirements

• Python 3.6

Installation

pip install py-incomepropertyevaluatorkit

Usage

Development

Here is an example of using the using the library in your code.

#TODO: Write example...

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.

python test_realestatekit.py

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.

coverage run test_analyzer.py
coverage report -m test_analyzer.py

License

This library is licensed under the BSD license. See LICENSE.md for more information.