Metadata-Version: 2.4
Name: pyRealEstate
Version: 0.2.0
Summary: package to assist with data analytics in real estate
Home-page: https://github.com/Joshua-Data-Wizard/PyRealEstate/tree/main
Author: Joshua Jorgensen
License: MIT License
        
        Copyright (c) 2023 Joshua Jorgensen
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Joshua-Data-Wizard/PyRealEstate/tree/main
Project-URL: Bug Reports, https://github.com/Joshua-Data-Wizard/PyRealEstate/tree/main
Project-URL: Source, https://github.com/Joshua-Data-Wizard/PyRealEstate/tree/main
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scikit-learn
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: statsmodels
Requires-Dist: matplotlib
Requires-Dist: seaborn
Requires-Dist: lightgbm
Requires-Dist: scipy
Dynamic: license-file

# pyRealEstate

pyRealEstate is a library designed for data scientists working in the real estate industry. pyRealEstate is still currently under development but is aimed at providing functions to assist in the development and evaluation of AVM's. Below are some instructions on how to get started with pyRealEstate and some helpful links to descriptions and examples of all of PyRealEstates functionality. 

## Installation

The pyRealEstate package is available on [PyPi](https://pypi.org/project/pyRealEstate). Simply run: 
```
pip install pyRealEstate
```
## AVM Evaluation Metrics
pyRealEstate can provide metrics on the evaluation of your AVM (Automated Valuation Model) such as the weighted mean sale ratio, COD (Coefficient Of Disspersion), PRD (Price Related Differential), PRB (Price Related Bias), and VEI (Vertical Equity Indicator). please visit the wiki for detailed documentation [pyRealEstate Evaluation](https://github.com/Joshua-Data-Wizard/PyRealEstate/wiki/AVM-Evaluation-Metrics).

## Data Pre Processing
In addition to the evaluation metrics for the models, pyRealEstate also offers a multitude of functions to help with the pre processing of data. Please visit the wiki for detailed documentation [pyRealEstate Pre Processing](https://github.com/Joshua-Data-Wizard/PyRealEstate/wiki/Pre-Processing).

## Time Trending for AVM's
In creating Automated Valuation Models (AVM's) for real estate, it is key to capture time trends in the market. There are typically two major approaches; one is to model the time trend and then to adjust the sales based on the time adjustment rate. The other option is to include time directly in the model. If one wishes to take the first approach this pyRealEstate is to assist in the finding of the time adjustment rates. Please visit the wiki for detailed documentation [pyRealEstate Time Trending](https://github.com/Joshua-Data-Wizard/PyRealEstate/wiki/Time-Trending).
