semvec/pypi-packages huggingface dataset:
py-incomepropertyevaluatorkit 0.0.1
Python library for performing rental and income property calculations.
License: BSD 2-Clause License
Requires Python: >=3.6
Keywords: mortgage real estate financial business bank

# py-incomepropertyevaluatorkit
## Build Status
[![Build Status](https://travis-ci.org/MikaSoftware/py-incomepropertyevaluatorkit.svg?branch=master)](https://travis-ci.org/MikaSoftware/py-incomepropertyevaluatorkit)
[![Coverage Status](https://coveralls.io/repos/github/MikaSoftware/py-incomepropertyevaluatorkit/badge.svg?branch=master)](https://coveralls.io/github/MikaSoftware/py-incomepropertyevaluatorkit?branch=master)
**This library is currently being developed and is not production quality ready!**

## Overview
Python library for performing rental and income property calculations.

## Minimum Requirements
* Python 3.6

## Installation
  ```bash
  pip install py-incomepropertyevaluatorkit
  ```

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

  ```python
  #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.

```bash
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](http://coverage.readthedocs.io/en/latest/).

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

## License
This library is licensed under the **BSD** license. See [LICENSE.md](LICENSE.md) for more information.