Metadata-Version: 2.4
Name: openavmkit
Version: 0.1.0
Summary: Open-source automated valuation model (AVM) toolkit
Home-page: https://github.com/larsiusprime/openavmkit
Author: Lars A. Doucet
Author-email: "Lars A. Doucet" <lars.doucet+openavmkit@gmail.com>
License-Expression: AGPL-3.0-only OR LicenseRef-proprietary
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.23
Requires-Dist: pandas>=2.2
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"
Dynamic: author
Dynamic: home-page
Dynamic: requires-python

# OpenAVMKit

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.

# Table of Contents

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