Metadata-Version: 2.4
Name: openavmkit
Version: 0.5.1
Summary: Open-source automated valuation model (AVM) toolkit
Author-email: "Lars A. Doucet" <lars.doucet+openavmkit@gmail.com>
Project-URL: Homepage, https://www.openavmkit.com/
Project-URL: Source, https://github.com/larsiusprime/openavmkit
Project-URL: Issues, https://github.com/larsiusprime/openavmkit/issues
Project-URL: Changelog, https://github.com/larsiusprime/openavmkit/blob/master/CHANGELOG.md
Keywords: avm,mass appraisal,valuation,gis,real estate
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: License :: Other/Proprietary License
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: azure-storage-blob==12.27.1
Requires-Dist: catboost==1.2.8
Requires-Dist: numpy==2.2.6
Requires-Dist: huggingface-hub==1.1.2
Requires-Dist: lightgbm==4.6.0
Requires-Dist: markdown==3.10
Requires-Dist: mgwr==2.2.1
Requires-Dist: optuna==4.6.0
Requires-Dist: osmnx==2.0.7
Requires-Dist: paramiko==4.0.0
Requires-Dist: pdfkit==1.0.0
Requires-Dist: pipreqs==0.5.0
Requires-Dist: polars==1.35.2
Requires-Dist: pyarrow==22.0.0
Requires-Dist: pytest==9.0.1
Requires-Dist: python-dotenv==1.1.1
Requires-Dist: rich==14.2.0
Requires-Dist: seaborn==0.13.2
Requires-Dist: statsmodels==0.14.5
Requires-Dist: xgboost==3.1.1
Requires-Dist: xlsxwriter==3.2.9
Requires-Dist: census==0.8.24
Requires-Dist: shap==0.50.0
Requires-Dist: mpld3==0.5.12
Requires-Dist: hilbertcurve==2.0.5
Requires-Dist: optuna-integration==4.5.0
Requires-Dist: tabulate~=0.9.0
Requires-Dist: pygam~=0.11.0
Requires-Dist: pandas~=2.3.3
Requires-Dist: ipython~=8.12.3
Requires-Dist: geopandas~=1.1.1
Requires-Dist: matplotlib~=3.10.7
Requires-Dist: pyproj~=3.7.1
Requires-Dist: shapely~=2.1.2
Requires-Dist: azure-core~=1.36.0
Requires-Dist: requests~=2.32.3
Requires-Dist: joblib~=1.5.2
Requires-Dist: scipy<1.16,>=1.11.4
Requires-Dist: scikit-learn~=1.7.2
Requires-Dist: tqdm~=4.67.1
Provides-Extra: docs
Requires-Dist: mkdocs>=1.6; extra == "docs"
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.25; extra == "docs"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"

# OpenAVMKit

[![PyPI version](https://img.shields.io/pypi/v/openavmkit?color=blue)](https://pypi.org/project/openavmkit/)
![Python versions](https://img.shields.io/pypi/pyversions/openavmkit.svg)
[![CI](https://github.com/larsiusprime/openavmkit/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/larsiusprime/openavmkit/actions/workflows/ci.yml)

OpenAVMKit is a python library for real estate mass appraisal. It includes modules for data cleaning, data enrichment, modeling, and statistical evaluation of predictive models. It also includes Jupyter notebooks that model typical workflows.

See the [Changelog](changelog.md)

# Table of Contents

## 1. Getting started
  - [Install from PyPI](docs/docs/getting_started.md#option-1---install-from-pypi)
  - [Install from Git](docs/docs/getting_started.md#option-2---install-from-git)
  - [Running Tests](docs/docs/getting_started.md#running-tests)
  - [Running your first locality](docs/docs/getting_started.md#running-your-first-locality)
## 2. The basics
  - [Creating a new locality](docs/docs/the_basics.md#creating-a-new-locality)
  - [Code modules](docs/docs/the_basics.md#code-modules)
  - [Jupyter Notebooks](docs/docs/the_basics.md#using-the-jupyter-notebooks)
  - [Terminology](docs/docs/the_basics.md#terminology)
## 3. Configuration
  - [Cloud storage](docs/docs/config.md#configuring-cloud-storage)
  - [PDF report generation](docs/docs/config.md#configuring-pdf-report-generation)
  - [US Census API](docs/docs/config.md#configuring-census-api-access)
  - [Open Street Map API](docs/docs/config.md#configuring-openstreetmap-enrichment)
## 4. Legal
  - [Contributing](CONTRIBUTING.md)
  - [License](LICENSE)
  - [License Philosophy](LICENSE-PHILOSOPHY.md)
