plat-costmodel 0.1.0__tar.gz

plat_costmodel-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

plat_costmodel-0.1.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: plat-costmodel
+Version: 0.1.0
+Summary: Multifamily renovation cost estimation engine: line-item estimates, SOW generation, contractor bid evaluation, and ROI gating
+Author: paintbrush
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/paintbrushv/plat-costmodel
+Project-URL: Repository, https://github.com/paintbrushv/plat-costmodel
+Project-URL: Issues, https://github.com/paintbrushv/plat-costmodel/issues
+Project-URL: Changelog, https://github.com/paintbrushv/plat-costmodel/blob/main/README.md
+Keywords: multifamily,real-estate,renovation,cost-estimation,value-add,proptech
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: python-ulid>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Provides-Extra: server
+Requires-Dist: mcp<2,>=1.0; extra == "server"
+Dynamic: license-file
+
+# plat-costmodel
+
+Multifamily renovation cost estimation engine for Plat — a domain-expert real estate intelligence agent.
+
+## What It Does
+
+- **Per-unit cost estimation** with line-item breakdowns (flooring, kitchen, bath, paint, appliances, fixtures, contingency)
+- **Scope of Work (SOW) generation** — contractor-ready documents from property profile
+- **Contractor bid evaluation** — flags inflated line items, vague lump sums, unrealistic timelines
+- **ROI gating** — 15% minimum threshold check on all renovation plans
+- **Risk flagging** — age-based warnings (galvanized pipe, asbestos, foundation concerns)
+- **Budget vs. actual tracking** — Yardi Voyager integration for model calibration
+
+## Architecture
+
+MCP tool server callable by Plat's orchestration layer. CLI-first interface.
+
+```
+Plat (agent) ──MCP──▶ plat-costmodel (tool server)
+                            ├── estimate    — per-unit cost range
+                            ├── sow         — scope of work generation
+                            ├── evaluate    — contractor bid evaluation
+                            ├── roi         — ROI threshold check
+                            └── ingest      — Yardi CSV import
+```
+
+## Two Scope Levels
+
+| Scope | Cost Range | Description |
+|-------|-----------|-------------|
+| Light | $3K-$5K/unit | Paint, clean, patch, hardware, carpet |
+| Standard Value-Add | $12K-$18K/unit | Full kitchen/bath update, LVP, appliances, fixtures |
+
+Gut renos excluded — don't pencil at Class C rents.
+
+## Cost Model Inputs
+
+- Unit square footage (<700 small, 700-950 medium, 950+ large)
+- Finish tier (basic vs. upgraded)
+- Number of bedrooms/bathrooms
+- Property year built (drives risk flags)
+- Property class (B or C)
+- Market (Dallas, Birmingham — more later)
+
+## Data Sources
+
+- **Brain dump knowledge** — Day 1 baseline from operator experience
+- **Yardi Voyager CSV exports** — historical actuals tagged to unit numbers
+- **RSMeans benchmarks** — industry reference data (future)
+- **Cross-user pooled data** — anonymous Glassdoor-style model (SaaS future)

plat_costmodel-0.1.0/README.md

@@ -0,0 +1,50 @@
+# plat-costmodel
+
+Multifamily renovation cost estimation engine for Plat — a domain-expert real estate intelligence agent.
+
+## What It Does
+
+- **Per-unit cost estimation** with line-item breakdowns (flooring, kitchen, bath, paint, appliances, fixtures, contingency)
+- **Scope of Work (SOW) generation** — contractor-ready documents from property profile
+- **Contractor bid evaluation** — flags inflated line items, vague lump sums, unrealistic timelines
+- **ROI gating** — 15% minimum threshold check on all renovation plans
+- **Risk flagging** — age-based warnings (galvanized pipe, asbestos, foundation concerns)
+- **Budget vs. actual tracking** — Yardi Voyager integration for model calibration
+
+## Architecture
+
+MCP tool server callable by Plat's orchestration layer. CLI-first interface.
+
+```
+Plat (agent) ──MCP──▶ plat-costmodel (tool server)
+                            ├── estimate    — per-unit cost range
+                            ├── sow         — scope of work generation
+                            ├── evaluate    — contractor bid evaluation
+                            ├── roi         — ROI threshold check
+                            └── ingest      — Yardi CSV import
+```
+
+## Two Scope Levels
+
+| Scope | Cost Range | Description |
+|-------|-----------|-------------|
+| Light | $3K-$5K/unit | Paint, clean, patch, hardware, carpet |
+| Standard Value-Add | $12K-$18K/unit | Full kitchen/bath update, LVP, appliances, fixtures |
+
+Gut renos excluded — don't pencil at Class C rents.
+
+## Cost Model Inputs
+
+- Unit square footage (<700 small, 700-950 medium, 950+ large)
+- Finish tier (basic vs. upgraded)
+- Number of bedrooms/bathrooms
+- Property year built (drives risk flags)
+- Property class (B or C)
+- Market (Dallas, Birmingham — more later)
+
+## Data Sources
+
+- **Brain dump knowledge** — Day 1 baseline from operator experience
+- **Yardi Voyager CSV exports** — historical actuals tagged to unit numbers
+- **RSMeans benchmarks** — industry reference data (future)
+- **Cross-user pooled data** — anonymous Glassdoor-style model (SaaS future)

plat_costmodel-0.1.0/pyproject.toml

@@ -0,0 +1,77 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "plat-costmodel"
+version = "0.1.0"
+description = "Multifamily renovation cost estimation engine: line-item estimates, SOW generation, contractor bid evaluation, and ROI gating"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    {name = "paintbrush"}
+]
+keywords = [
+    "multifamily",
+    "real-estate",
+    "renovation",
+    "cost-estimation",
+    "value-add",
+    "proptech",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: End Users/Desktop",
+    "Topic :: Office/Business :: Financial :: Accounting",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Intended Audience :: End Users/Desktop",
+    "Topic :: Office/Business :: Financial :: Accounting",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Office/Business :: Financial :: Investment",
+]
+dependencies = [
+    "click>=8.0",
+    "pydantic>=2.0",
+    "pyyaml>=6.0",
+    "python-ulid>=2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/paintbrushv/plat-costmodel"
+Repository = "https://github.com/paintbrushv/plat-costmodel"
+Issues = "https://github.com/paintbrushv/plat-costmodel/issues"
+Changelog = "https://github.com/paintbrushv/plat-costmodel/blob/main/README.md"
+
+[project.scripts]
+plat-cost = "plat_costmodel.cli:cli"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+]
+# The standalone plat-costmodel MCP server. Pinned to mcp 1.x (2.x renames
+# FastMCP); the service modules (estimator/roi/sow/bid_eval) never import mcp,
+# so the core package installs cleanly alongside mcp 2.x consumers like
+# platworks.
+server = [
+    "mcp>=1.0,<2",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+plat_costmodel = ["data/*.yaml"]
+"plat_costmodel.store" = ["migrations/*.sql"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

plat_costmodel-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

plat_costmodel-0.1.0/src/plat_costmodel/__init__.py

@@ -0,0 +1,3 @@
+"""plat-costmodel: Multifamily renovation cost estimation engine for Plat."""
+
+__version__ = "0.1.0"

plat_costmodel-0.1.0/src/plat_costmodel/amenity_estimator.py

@@ -0,0 +1,116 @@
+"""Pure amenity-program cost estimator.
+
+Given an AmenityCohort + the loaded knowledge base, compute install + opex
+cost ranges and optional success-metric results (occupancy lift, rent premium).
+
+Quantity rules:
+- install + opex multiply by ``cohort.quantity``
+- ``typical_occupancy_lift_pct`` is per-installation (saturation effect on
+  a second pool), so NOT multiplied by quantity
+- ``typical_rent_premium_monthly`` IS multiplied by quantity (per-unit pricing
+  for ev_chargers etc.)
+
+Gates fire only when both the caller's expected target AND the KB's typical
+projection are present. If either is missing, the corresponding result is
+None — we don't fabricate a projection from no data.
+
+This module is dependency-free of the persistence layer; it returns a plain
+dict that scope_service._estimate_amenity shapes into an AmenityScopeEstimate.
+"""
+from __future__ import annotations
+
+from typing import Optional
+
+from plat_costmodel.schemas import (
+    AmenityCohort,
+    OccupancyLiftResult,
+    RentPremiumResult,
+    raise_problem,
+)
+
+
+def estimate_amenity(cohort: AmenityCohort, kb: dict) -> dict:
+    """Compute amenity cost components + optional success-metric results.
+
+    Returns a dict with keys: install_cost_low, install_cost_high,
+    annual_opex_low, annual_opex_high, expected_occupancy_lift_result,
+    expected_rent_premium_result.
+    """
+    catalog = kb.get("amenity_catalog", {})
+    entry = catalog.get(cohort.amenity_type)
+    if entry is None:
+        raise_problem(
+            "validation_error",
+            f"amenity_type {cohort.amenity_type!r} not in knowledge_base.amenity_catalog",
+            field_errors=[{
+                "loc": ["cohort", "amenity_type"],
+                "msg": f"unknown amenity_type: {cohort.amenity_type!r}",
+            }],
+            hint="Use one of: " + ", ".join(sorted(catalog.keys())),
+        )
+
+    qty = cohort.quantity
+    install_low = float(entry["install_low"]) * qty
+    install_high = float(entry["install_high"]) * qty
+    annual_opex_low: Optional[float] = (
+        float(entry["annual_opex_low"]) * qty
+        if "annual_opex_low" in entry else None
+    )
+    annual_opex_high: Optional[float] = (
+        float(entry["annual_opex_high"]) * qty
+        if "annual_opex_high" in entry else None
+    )
+
+    # Occupancy lift gate — fires only if caller supplied a target AND
+    # KB has a typical projection.
+    lift_result: Optional[OccupancyLiftResult] = None
+    if (
+        cohort.expected_occupancy_lift_pct is not None
+        and "typical_occupancy_lift_pct" in entry
+    ):
+        target = float(cohort.expected_occupancy_lift_pct)
+        # NOT multiplied by quantity — saturation effect on second-pool etc.
+        projected = float(entry["typical_occupancy_lift_pct"])
+        clears = projected >= target
+        shortfall = (target - projected) if not clears else None
+        lift_result = OccupancyLiftResult(
+            target_lift_pct=target,
+            projected_lift_pct=projected,
+            clears_threshold=clears,
+            shortfall_pct=shortfall,
+        )
+
+    # Rent premium gate — fires only if caller supplied a target AND KB has
+    # a typical premium. typical_rent_premium_monthly IS multiplied by qty.
+    premium_result: Optional[RentPremiumResult] = None
+    if (
+        cohort.expected_rent_premium_monthly is not None
+        and "typical_rent_premium_monthly" in entry
+    ):
+        target = float(cohort.expected_rent_premium_monthly)
+        projected = float(entry["typical_rent_premium_monthly"]) * qty
+        clears = projected >= target
+        shortfall_monthly = (target - projected) if not clears else None
+        premium_result = RentPremiumResult(
+            target_premium_monthly=target,
+            projected_premium_monthly=projected,
+            clears_threshold=clears,
+            shortfall_monthly=shortfall_monthly,
+        )
+
+    # deluxe field is read here to acknowledge it has been considered. The KB
+    # does not yet encode deluxe-tier cost multipliers, so this is intentionally
+    # a no-op until a future PR adds the pricing logic. The assignment to _ keeps
+    # this acknowledgment durable: a future automated refactor or linter sweep
+    # will not silently strip a bare attribute access, preserving the intent that
+    # deluxe was evaluated and deliberately left as a no-op rather than forgotten.
+    _ = cohort.deluxe
+
+    return {
+        "install_cost_low": install_low,
+        "install_cost_high": install_high,
+        "annual_opex_low": annual_opex_low,
+        "annual_opex_high": annual_opex_high,
+        "expected_occupancy_lift_result": lift_result,
+        "expected_rent_premium_result": premium_result,
+    }