platworks 0.1.0__tar.gz

platworks-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.

platworks-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: platworks
+Version: 0.1.0
+Summary: Umbrella package and MCP server for the plat commercial-real-estate ecosystem.
+License: Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=2.0
+Requires-Dist: anyio>=4.0
+Requires-Dist: click>=8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# platworks
+
+Umbrella package, MCP server, and landing assets for the **plat** commercial-real-estate
+ecosystem: a verified component catalog served as MCP tools, a synthetic end-to-end
+demo, and a standalone landing page — all generated from one source of truth.
+
+The plat ecosystem's principle: **numbers come from deterministic engines, never from
+a model.** This umbrella makes the ecosystem navigable — one catalog, one MCP server,
+one honest landing page.
+
+## Components (verified catalog)
+
+| Component | What it is |
+|---|---|
+| [plat-multifamily-underwriting](https://github.com/paintbrushv/plat-multifamily-underwriting) | Deterministic multifamily underwriting engine |
+| [plat-harness](https://github.com/paintbrushv/plat-harness) | Agent-agnostic control plane for underwriting and asset operations |
+| [plat-market-study-agent](https://github.com/paintbrushv/plat-market-study-agent) | Expert-level multifamily market studies with strict data separation |
+| [plat-operations](https://github.com/paintbrushv/plat-operations) | Local-first NOI variance intelligence harness (BOXSCORE, Rust) |
+| [geostack](https://github.com/paintbrushv/geostack) | PostGIS/GIS utility layer for multifamily market analytics |
+
+A further four components (orchestration, cost modeling, submarket atlas, supply/demand)
+are private and not yet published; the catalog and MCP server report them as private with
+no repository links.
+
+## Install
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## The MCP server
+
+The `platworks-mcp` console script (or `python -m platworks.mcp_server`) runs an MCP
+stdio server exposing the verified catalog and the package's own product surface as
+eleven read-only tools:
+
+| Tool | What it does |
+|---|---|
+| `get_ecosystem_overview` | The ecosystem at a glance: counts, principle, tool list |
+| `list_components` | All components, optional `category` filter |
+| `get_component` | One component by exact name |
+| `find_components` | Components within one category |
+| `list_categories` | The closed category vocabulary with counts |
+| `list_public_components` | The public components that carry verified repo links |
+| `list_private_components` | Private components (names only — no public claims) |
+| `search_components` | Case-insensitive substring search across names, tags, descriptions |
+| `get_install_instructions` | Install commands and the MCP client config snippet |
+| `get_demo_portfolio` | The synthetic demo portfolio (fabricated, clearly labeled) |
+| `get_landing_page` | The standalone product landing page as HTML |
+
+Plus eight **product tools** that wrap the ecosystem's real deterministic
+services — the numbers come back exactly as the wrapped engine/costmodel/harness
+service computed them, with a provenance record on every response:
+
+| Tool | What it does |
+|---|---|
+| `underwrite_run` | Run the deterministic underwriting engine on a canonical deal; certified metrics verbatim |
+| `underwrite_backsolve` | Backsolve the highest purchase price meeting a target Year-1 post-debt CoC |
+| `tax_regime_lookup` | Researched, statute-cited property-tax regime schedules (TX CA FL AL; unknown states refuse) |
+| `renovation_estimate` | Per-unit renovation cost ranges with line items and age-based risk flags |
+| `renovation_roi` | ROI threshold check (conservative: high cost estimate) |
+| `generate_sow` | Contractor-ready scope of work with material specs |
+| `evaluate_bid` | Contractor bid evaluation against the internal estimate |
+| `ops_review` | Read-only one-property/one-period ops review; variance only through a bound oracle |
+
+The product tools import their sibling services lazily: the catalog server keeps
+working without them installed, and each product tool refuses with a typed
+`BACKEND_UNAVAILABLE` payload naming the missing service.
+
+Failures are typed refusals inside the payload
+(`{"error": {"type": ..., "message": ...}}`) naming the valid options, never opaque
+crashes. The tool list is declared once in `platworks.tools` and the server, landing
+page, and tests all derive from it. Wire it into any MCP client:
+
+```json
+{
+  "mcpServers": {
+    "platworks": {
+      "command": "platworks-mcp"
+    }
+  }
+}
+```
+
+## CLI quickstart
+
+```bash
+platworks catalog                 # human-readable component list
+platworks catalog --json          # exact catalog module output
+platworks catalog --category geospatial
+platworks get plat-harness        # one component
+platworks demo                    # write the synthetic demo to ./platworks-demo
+platworks landing                 # render landing.html (standalone, no external assets)
+platworks mcp                     # run the MCP stdio server
+```
+
+Exit codes are stable: `0` success, `2` typed refusal (unknown component/category)
+with an actionable message on stderr.
+
+## The demo (synthetic only)
+
+```bash
+platworks demo ./demo && python demo/run_demo.py
+```
+
+The demo writes a **synthetic** three-property portfolio (fabricated names, cities,
+and numbers) and an executable script that starts the real MCP server over stdio,
+connects as a genuine MCP client, and exercises all eleven tools end to end:
+ecosystem overview, category vocabulary, catalog browsing, keyword search, the
+install instructions, the served portfolio, the landing page, and each asset's
+component mapping resolved against the verified catalog.
+
+## The landing page
+
+`platworks landing` renders a single self-contained HTML file — inline CSS, no CDN,
+no scripts, no tracking — from the live catalog and tool registry: public components
+with their verified repository links, private components honestly marked private,
+the eleven MCP tools the server ships, and copy-paste install instructions.
+
+## Honest scope
+
+- **Catalog claims are verified.** Public repository URLs and descriptions were
+  verified against the GitHub API on 2026-09-24 and are copied verbatim; drift-gate
+  tests fail the suite if a doc or generated page claims an unverified URL.
+- **Synthetic data only.** No real deal, tenant, owner, or portfolio data ships in
+  this package or its demo.
+- **Private components make no public claims.** No repo URLs, no descriptions —
+  for private entries the catalog returns `null` and says so.
+- **No network calls at runtime.** The MCP server, CLI, and landing generator read
+  the packaged catalog only.
+
+## Layout
+
+```
+src/platworks/    catalog, MCP server, CLI, demo + landing generators
+tests/            pytest suite (drift gates included; slow marks for stdio e2e)
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE). Demo data is synthetic and marked as such.

platworks-0.1.0/README.md

@@ -0,0 +1,143 @@
+# platworks
+
+Umbrella package, MCP server, and landing assets for the **plat** commercial-real-estate
+ecosystem: a verified component catalog served as MCP tools, a synthetic end-to-end
+demo, and a standalone landing page — all generated from one source of truth.
+
+The plat ecosystem's principle: **numbers come from deterministic engines, never from
+a model.** This umbrella makes the ecosystem navigable — one catalog, one MCP server,
+one honest landing page.
+
+## Components (verified catalog)
+
+| Component | What it is |
+|---|---|
+| [plat-multifamily-underwriting](https://github.com/paintbrushv/plat-multifamily-underwriting) | Deterministic multifamily underwriting engine |
+| [plat-harness](https://github.com/paintbrushv/plat-harness) | Agent-agnostic control plane for underwriting and asset operations |
+| [plat-market-study-agent](https://github.com/paintbrushv/plat-market-study-agent) | Expert-level multifamily market studies with strict data separation |
+| [plat-operations](https://github.com/paintbrushv/plat-operations) | Local-first NOI variance intelligence harness (BOXSCORE, Rust) |
+| [geostack](https://github.com/paintbrushv/geostack) | PostGIS/GIS utility layer for multifamily market analytics |
+
+A further four components (orchestration, cost modeling, submarket atlas, supply/demand)
+are private and not yet published; the catalog and MCP server report them as private with
+no repository links.
+
+## Install
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## The MCP server
+
+The `platworks-mcp` console script (or `python -m platworks.mcp_server`) runs an MCP
+stdio server exposing the verified catalog and the package's own product surface as
+eleven read-only tools:
+
+| Tool | What it does |
+|---|---|
+| `get_ecosystem_overview` | The ecosystem at a glance: counts, principle, tool list |
+| `list_components` | All components, optional `category` filter |
+| `get_component` | One component by exact name |
+| `find_components` | Components within one category |
+| `list_categories` | The closed category vocabulary with counts |
+| `list_public_components` | The public components that carry verified repo links |
+| `list_private_components` | Private components (names only — no public claims) |
+| `search_components` | Case-insensitive substring search across names, tags, descriptions |
+| `get_install_instructions` | Install commands and the MCP client config snippet |
+| `get_demo_portfolio` | The synthetic demo portfolio (fabricated, clearly labeled) |
+| `get_landing_page` | The standalone product landing page as HTML |
+
+Plus eight **product tools** that wrap the ecosystem's real deterministic
+services — the numbers come back exactly as the wrapped engine/costmodel/harness
+service computed them, with a provenance record on every response:
+
+| Tool | What it does |
+|---|---|
+| `underwrite_run` | Run the deterministic underwriting engine on a canonical deal; certified metrics verbatim |
+| `underwrite_backsolve` | Backsolve the highest purchase price meeting a target Year-1 post-debt CoC |
+| `tax_regime_lookup` | Researched, statute-cited property-tax regime schedules (TX CA FL AL; unknown states refuse) |
+| `renovation_estimate` | Per-unit renovation cost ranges with line items and age-based risk flags |
+| `renovation_roi` | ROI threshold check (conservative: high cost estimate) |
+| `generate_sow` | Contractor-ready scope of work with material specs |
+| `evaluate_bid` | Contractor bid evaluation against the internal estimate |
+| `ops_review` | Read-only one-property/one-period ops review; variance only through a bound oracle |
+
+The product tools import their sibling services lazily: the catalog server keeps
+working without them installed, and each product tool refuses with a typed
+`BACKEND_UNAVAILABLE` payload naming the missing service.
+
+Failures are typed refusals inside the payload
+(`{"error": {"type": ..., "message": ...}}`) naming the valid options, never opaque
+crashes. The tool list is declared once in `platworks.tools` and the server, landing
+page, and tests all derive from it. Wire it into any MCP client:
+
+```json
+{
+  "mcpServers": {
+    "platworks": {
+      "command": "platworks-mcp"
+    }
+  }
+}
+```
+
+## CLI quickstart
+
+```bash
+platworks catalog                 # human-readable component list
+platworks catalog --json          # exact catalog module output
+platworks catalog --category geospatial
+platworks get plat-harness        # one component
+platworks demo                    # write the synthetic demo to ./platworks-demo
+platworks landing                 # render landing.html (standalone, no external assets)
+platworks mcp                     # run the MCP stdio server
+```
+
+Exit codes are stable: `0` success, `2` typed refusal (unknown component/category)
+with an actionable message on stderr.
+
+## The demo (synthetic only)
+
+```bash
+platworks demo ./demo && python demo/run_demo.py
+```
+
+The demo writes a **synthetic** three-property portfolio (fabricated names, cities,
+and numbers) and an executable script that starts the real MCP server over stdio,
+connects as a genuine MCP client, and exercises all eleven tools end to end:
+ecosystem overview, category vocabulary, catalog browsing, keyword search, the
+install instructions, the served portfolio, the landing page, and each asset's
+component mapping resolved against the verified catalog.
+
+## The landing page
+
+`platworks landing` renders a single self-contained HTML file — inline CSS, no CDN,
+no scripts, no tracking — from the live catalog and tool registry: public components
+with their verified repository links, private components honestly marked private,
+the eleven MCP tools the server ships, and copy-paste install instructions.
+
+## Honest scope
+
+- **Catalog claims are verified.** Public repository URLs and descriptions were
+  verified against the GitHub API on 2026-09-24 and are copied verbatim; drift-gate
+  tests fail the suite if a doc or generated page claims an unverified URL.
+- **Synthetic data only.** No real deal, tenant, owner, or portfolio data ships in
+  this package or its demo.
+- **Private components make no public claims.** No repo URLs, no descriptions —
+  for private entries the catalog returns `null` and says so.
+- **No network calls at runtime.** The MCP server, CLI, and landing generator read
+  the packaged catalog only.
+
+## Layout
+
+```
+src/platworks/    catalog, MCP server, CLI, demo + landing generators
+tests/            pytest suite (drift gates included; slow marks for stdio e2e)
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE). Demo data is synthetic and marked as such.

platworks-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "platworks"
+version = "0.1.0"
+description = "Umbrella package and MCP server for the plat commercial-real-estate ecosystem."
+readme = "README.md"
+license = { text = "Apache-2.0" }
+requires-python = ">=3.11"
+dependencies = [
+    "mcp>=2.0",
+    "anyio>=4.0",
+    "click>=8.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.1.0",
+]
+
+[project.scripts]
+platworks = "platworks.cli:main"
+platworks-mcp = "platworks.mcp_server:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = [
+    "slow: slow end-to-end tests (real stdio subprocess round-trips)",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]

platworks-0.1.0/setup.cfg

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

platworks-0.1.0/src/platworks/__init__.py

@@ -0,0 +1,29 @@
+"""platworks — umbrella package for the plat commercial-real-estate ecosystem.
+
+Exposes a verified component catalog and an MCP server that serves it.
+
+All data in this package is public metadata about sibling repositories
+(verified against the GitHub API on 2026-09-24) or synthetic demo data.
+No deal, tenant, or portfolio data ships in this package.
+"""
+
+__version__ = "0.1.0"
+
+from platworks import catalog
+from platworks.catalog import (
+    UnknownCategoryError,
+    UnknownComponentError,
+    find_components,
+    get_component,
+    list_components,
+)
+
+__all__ = [
+    "__version__",
+    "catalog",
+    "find_components",
+    "get_component",
+    "list_components",
+    "UnknownCategoryError",
+    "UnknownComponentError",
+]