semantic-rails 0.1.0__tar.gz

semantic_rails-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 WTremml
+
+   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.

semantic_rails-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+Semantic Rails
+Copyright 2026 WTremml
+
+This product is licensed under the Apache License, Version 2.0
+(see the LICENSE file in the root of this repository).

semantic_rails-0.1.0/PKG-INFO

@@ -0,0 +1,380 @@
+Metadata-Version: 2.4
+Name: semantic-rails
+Version: 0.1.0
+Summary: Agent-first semantic layer for governed analytics over DuckDB and Snowflake
+Author: WTremml
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://semantic-rails.com
+Project-URL: Documentation, https://semantic-rails.com/docs/
+Project-URL: Source, https://github.com/semantic-rails/semantic-rails
+Project-URL: Issues, https://github.com/semantic-rails/semantic-rails/issues
+Project-URL: Changelog, https://github.com/semantic-rails/semantic-rails/blob/main/CHANGELOG.md
+Keywords: analytics,duckdb,metrics,semantic-layer,snowflake,sql
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: duckdb>=1.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: server
+Requires-Dist: uvicorn>=0.30; extra == "server"
+Provides-Extra: snowflake
+Requires-Dist: snowflake-connector-python>=3.10; extra == "snowflake"
+Provides-Extra: all
+Requires-Dist: uvicorn>=0.30; extra == "all"
+Requires-Dist: snowflake-connector-python>=3.10; extra == "all"
+Dynamic: license-file
+
+# Semantic Rails
+
+> If your agent can't `discover → inspect → plan/build-options → valid-values → validate → compile → execute` before it queries, you don't have a semantic layer for agents — you have a SQL generator with a metric registry. Semantic Rails is the runtime that makes that loop deterministic.
+
+Semantic Rails is an Apache-2.0-licensed, agent-first semantic layer. It ships an MCP server (stdio + HTTP) and an HTTP/JSON API where each of those steps is a separately introspectable tool. Modelling errors — unknown metrics, dimension mismatches, invalid filters, policy violations — are structured envelopes that, where applicable, include `recovery_hints` and `closest_matches`; transport-level errors (invalid JSON, missing auth, unrouted paths) use a leaner envelope with a `code` and `message`. Every off-topic intent is routed through a relevance floor inside `discover` and `plan` before the runtime answers. DuckDB locally, Snowflake through Snow CLI or the native connector.
+
+```bash
+pip install semantic-rails
+semantic-rails packages   # lists the bundled jaffle_shop proof package
+semantic-rails query --package jaffle_shop --query-json '{
+  "version": 1,
+  "select": [{"expression": {"measure": "measure.jaffle.revenue_usd"}, "as": "revenue_usd"}],
+  "group_by": ["dimension.jaffle_store_name"],
+  "order_by": [{"field": "revenue_usd", "direction": "DESC"}],
+  "limit": 5
+}'
+```
+
+The same payload works against `discover`, `validate`, `compile`, and `explain` — each is a
+separate, introspectable step of the same loop. Working from a clone instead (contributors,
+or to use the ready-made payloads under `examples/`):
+
+```bash
+git clone https://github.com/semantic-rails/semantic-rails.git
+cd semantic-rails
+uv sync --group dev
+uv run semantic-rails query --package jaffle_shop --query-json '@examples/jaffle_shop_revenue_by_store.json'
+```
+
+Website: [semantic-rails.com](https://semantic-rails.com) ·
+[Try live](https://semantic-rails.com/try) ·
+[Hosted MCP](https://semantic-rails.com/mcp-docs)
+
+License: Apache 2.0; see [LICENSE](LICENSE). Community support, issue reporting, conduct, and security
+reporting are documented in [SUPPORT.md](SUPPORT.md), [CONTRIBUTING.md](CONTRIBUTING.md),
+[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and [SECURITY.md](SECURITY.md).
+
+## What Semantic Rails is NOT
+
+Three categories readers commonly reach for first. None of them describe this project.
+
+- **Not the Open Semantic Interface (OSI).** OSI is a metadata-interchange spec — "the JSON-Schema for semantic layers." Semantic Rails is a runtime: it compiles deterministic SQL, runs an MCP server that exposes `discover → inspect → plan/build-options → valid-values → validate → compile → execute` as separate tools, and ships governed primitives (`metric_predicate`, temporal-validity joins, same-store conversion, contextual entity-graph inheritance) with reviewed guardrails. OSI compatibility would be a metadata adapter we could add later. It would not be the product.
+- **Not another MetricFlow / Cube / Malloy / Snowflake Semantic View.** Those are SQL-generation layers. Semantic Rails is an agent runtime where SQL generation is *one of seven steps an LLM can introspect*. See [comparisons/semantic_layers/](comparisons/semantic_layers/) — on the q01–q07 baseline nearly every layer scores 7 native (Cube takes one workaround, on q05), and the pack shows the cost of the workaround on q08–q16, where Semantic Rails's primitives are first-class.
+- **Not dbt Semantic Layer Cloud.** dbt's Semantic Layer is a hosted product, and its MCP server exposes a handful of semantic-layer tools shaped around list-metrics/get-dimensions/query. Semantic Rails is open-source Apache 2.0, runs locally on DuckDB or Snowflake, and exposes the full loop — discovery, inspection, guided building, validation, compile, and execution — as 13 separately introspectable MCP tools with structured recovery envelopes. The hostable-without-forking work (pluggable audit sinks, env-controlled CORS, per-request limits, in-process reload, public `Runtime.set_compile_cache` seam) makes a future hosted product possible — it is not the OSS product.
+
+The shape of the runtime is the differentiator. An MCP server with a relevance floor, structured error envelopes, and seven introspectable steps is not the same primitive as a SQL renderer, even when both can answer "revenue by store last month."
+
+## Runtime Shape
+
+- Runtime package: `semantic_rails/`
+- Package configs: `configs/semantic_rails/<package>/`
+- Public website: `website/`
+- Focused tests: `tests/semantic_rails/`
+
+## Documentation
+
+Start here depending on what you need:
+
+- Project overview and first run: [README.md](README.md)
+- Package authoring: [PACKAGE_AUTHORING.md](docs/PACKAGE_AUTHORING.md)
+- Deployment: [DEPLOYMENT.md](docs/DEPLOYMENT.md)
+- MCP interface: [MCP_INTERFACE.md](docs/MCP_INTERFACE.md)
+- Agent API path: [AGENT_API_PATH.md](docs/AGENT_API_PATH.md)
+- Query AST and API contracts: [QUERY_API.md](docs/QUERY_API.md)
+- Query IR JSON Schema (Draft 2020-12): [QUERY_IR_SCHEMA.md](docs/QUERY_IR_SCHEMA.md) · [schemas/query_ir.v1.json](schemas/query_ir.v1.json)
+- Supported capabilities and current limits: [CAPABILITIES.md](docs/CAPABILITIES.md)
+- Current runtime status: [CURRENT_RUNTIME.md](docs/CURRENT_RUNTIME.md)
+- Architecture spec: [ARCHITECTURE.md](docs/ARCHITECTURE.md)
+- Contributor guide: [CONTRIBUTING.md](CONTRIBUTING.md)
+- Comparative capability evidence vs MetricFlow, Cube, Malloy, and Snowflake Semantic Views: [comparisons/semantic_layers/](comparisons/semantic_layers/)
+- Migrating from MetricFlow: `semantic-rails import --from metricflow` translates a dbt/MetricFlow project into a Semantic Rails package — see [mf2sr/](mf2sr/) for what translates and what is dropped with warnings
+- Annotated reference artifact: [semantic_rails_capabilities_reference.yml](configs/examples/semantic_rails_capabilities_reference.yml)
+- Starter package: [semantic_rails_package_starter.yml](configs/examples/semantic_rails_package_starter.yml)
+
+## Package Naming
+
+Semantic Rails is the public product name; the PyPI distribution is `semantic-rails`, the Python import package is `semantic_rails`, and the CLI is `semantic-rails`. The wheel ships the `semantic_rails` package and `mf2sr` (the MetricFlow translator behind `semantic-rails import`). (The project was developed under the `semantic_layer` name, but the unrelated PyPI project `semantic-layer` owns that import namespace, so everything was renamed before first publish — no compatibility shim ships.)
+
+## Quickstart
+
+Start from a clean checkout with Python 3.11+ and `uv` installed. If you do not have `uv`, install it from
+[docs.astral.sh/uv](https://docs.astral.sh/uv/) and reopen your shell.
+
+```bash
+git clone https://github.com/semantic-rails/semantic-rails.git
+cd semantic-rails
+```
+
+```bash
+uv venv
+uv sync --group dev
+```
+
+Build and smoke-test the installable wheel when checking the packaging path:
+
+```bash
+uv build --wheel
+python3 -m venv /tmp/semantic-rails-wheel-smoke
+/tmp/semantic-rails-wheel-smoke/bin/python -m pip install dist/semantic_rails-0.1.0-py3-none-any.whl
+/tmp/semantic-rails-wheel-smoke/bin/semantic-rails packages
+uv run python scripts/verify_package_distribution.py
+```
+
+Without `uv`, install the built wheel into any environment with plain pip:
+
+```bash
+python -m pip install dist/semantic_rails-0.1.0-py3-none-any.whl
+```
+
+The wheel includes the `semantic_rails` runtime, the `semantic-rails` console script, the bundled
+`jaffle_shop` proof package, and its local DuckDB/CSV seed assets. The distribution verifier builds
+a fresh wheel, installs it into an isolated virtual environment, and runs `packages`, `catalog`, and
+`query` from that installed environment.
+
+List packages:
+
+```bash
+uv run semantic-rails packages
+```
+
+Expected output includes the bundled proof package:
+
+```text
+jaffle_shop
+```
+
+Inspect catalog and package metadata:
+
+```bash
+uv run semantic-rails catalog --package jaffle_shop
+uv run semantic-rails discover --package jaffle_shop --terms drinks
+uv run semantic-rails inspect --package jaffle_shop --object-id measure.jaffle.order_count
+uv run semantic-rails build-options --package jaffle_shop --query-json '@examples/jaffle_shop_revenue_by_store.json' --step group_by
+uv run semantic-rails plan --package jaffle_shop --intent "new customer orders over time"
+```
+
+Validate, compile, and query:
+
+```bash
+uv run semantic-rails validate --package jaffle_shop --query-json '@examples/jaffle_shop_revenue_by_store.json'
+uv run semantic-rails compile --package jaffle_shop --query-json '@examples/jaffle_shop_revenue_by_store.json'
+uv run semantic-rails query --package jaffle_shop --query-json '@examples/jaffle_shop_revenue_by_store.json'
+```
+
+The `compile` response includes an `explain` payload with the semantic and physical plan, chosen relationship paths, candidate paths, and relationship contracts.
+
+A successful query prints a JSON response with `rows`, `row_count`, `output_columns`, and execution metadata. For the
+bundled example, the row data is grouped by store using the local DuckDB fixture at
+`data/jaffle_shop.duckdb`.
+
+Parse and validate authored package configs:
+
+```bash
+uv run semantic-rails parse-config --package jaffle_shop
+uv run semantic-rails validate-config --package jaffle_shop
+uv run semantic-rails run-examples --package jaffle_shop
+uv run semantic-rails test-package --package jaffle_shop
+uv run semantic-rails check --package jaffle_shop
+uv run semantic-rails build-package --package jaffle_shop --output dist/jaffle_shop.semantic-rails.tar.gz
+uv run semantic-rails impact-report --package jaffle_shop --base-ref main
+uv run semantic-rails validate-config --path /path/to/package
+```
+
+`check` is the one-command package gate for GitHub-hosted configs. It runs parse, validation probes, package-local examples, package-local tests, and emits a manifest with the package hash. Pass `--artifact path/to/package.tar.gz` to write the deployable config artifact in the same run.
+
+Snowflake packages are supported through `package.warehouse: snowflake` plus either
+`package.connection.kind: snowflake_cli` or `snowflake_native`. The sample package is
+[tpch_sf1_showcase](configs/semantic_rails/tpch_sf1_showcase); live validation uses the Snow CLI
+and the configured `semantic_views_trial` connection documented in
+[SNOWFLAKE_SHOWCASE_RUNBOOK.md](docs/SNOWFLAKE_SHOWCASE_RUNBOOK.md). Native Snowflake execution is
+optional and keeps secrets in environment variables or files rather than package YAML.
+
+Run the server:
+
+```bash
+uv run semantic-rails serve --package jaffle_shop --port 8081
+```
+
+Run the packaged MCP server:
+
+```bash
+uv run semantic-rails mcp stdio --package jaffle_shop
+uv run semantic-rails mcp http --package jaffle_shop --host 127.0.0.1 --port 8091
+```
+
+The public launch endpoint is stateless MCP Streamable HTTP at
+`https://semantic-rails.com/mcp` using protocol version `2025-11-25`. It is an anonymous,
+scale-to-zero demo fixed to synthetic Jaffle Shop data: no uploads or external credentials,
+100 executed rows maximum, 25 segment-preview rows maximum, and edge rate/body/deadline limits.
+Use `summary`, `minimal`, or `compact` responses unless a debugging task requires `full`.
+
+Run the deployable ASGI service locally:
+
+```bash
+uv run --extra server uvicorn semantic_rails.asgi:app --host 0.0.0.0 --port 8081
+curl -s http://127.0.0.1:8081/api/v1/health
+curl -s http://127.0.0.1:8081/api/v1/ready
+```
+
+Day-1 backend smoke (what a new contributor actually needs):
+
+```bash
+uv run pytest -q tests/semantic_rails -n auto
+uv run semantic-rails check --package jaffle_shop
+```
+
+The full verification matrix — wheel smoke (`scripts/verify_package_distribution.py`),
+release-readiness verifier (`scripts/verify_release_readiness.py`) — is documented in
+[CONTRIBUTING.md § Full Verification Matrix](CONTRIBUTING.md#full-verification-matrix).
+
+Snowflake live smoke flow, after configuring the Snow CLI connection:
+
+```bash
+snow connection list
+uv run semantic-rails parse-config --package tpch_sf1_showcase
+uv run semantic-rails validate-config --package tpch_sf1_showcase
+uv run semantic-rails serve --package tpch_sf1_showcase --port 8092
+```
+
+## Example Query
+
+```json
+{
+  "version": 1,
+  "select": [
+    { "expression": { "measure": "measure.jaffle.revenue_usd" }, "as": "revenue_usd" },
+    { "expression": { "metric": "metric.sales.aov_usd" }, "as": "aov_usd" }
+  ],
+  "group_by": ["dimension.jaffle_store_name"],
+  "time": {
+    "temporal_role": "temporal_role.jaffle_order_time",
+    "grain": "month"
+  },
+  "policy_context": {
+    "environment": "production",
+    "audience": "finance"
+  },
+  "order_by": [{ "field": "revenue_usd", "direction": "DESC" }],
+  "limit": 25
+}
+```
+
+For the full request shape and response contracts, use [QUERY_API.md](docs/QUERY_API.md).
+
+## Use from Python
+
+Everything the MCP server and CLI expose is available in-process. `Runtime.query` takes the
+same Query IR payload and returns the same envelope, with `rows` as a list of dicts:
+
+```python
+from semantic_rails.runtime import Runtime
+
+runtime = Runtime("jaffle_shop")
+result = runtime.query(
+    {
+        "version": 1,
+        "select": [
+            {"expression": {"measure": "measure.jaffle.revenue_usd"}, "as": "revenue_usd"}
+        ],
+        "group_by": ["dimension.jaffle_store_name"],
+        "order_by": [{"field": "revenue_usd", "direction": "DESC"}],
+        "limit": 5,
+    }
+)
+rows = result["rows"]            # list[dict] — pd.DataFrame(rows) if you want a frame
+warnings = result["warnings"]    # advisory caveats, path warnings, rewrite notes
+runtime.close()
+```
+
+`Runtime("<package-id>")` loads a registered package; `Runtime.from_path("path/to/package")`
+loads a package directory or single-file YAML you are authoring.
+
+## HTTP API
+
+Routes are available under stable `/api/v1/*` paths. Discovery, authoring
+assistance, execution, and segments make up the v1 surface of 16 routes —
+the full list with request and response shapes is documented in
+[QUERY_API.md](docs/QUERY_API.md#http-routes). Stability policy: from 0.1.0
+on, `/api/v1` routes are append-only — removing a route or breaking a
+request/response shape requires a new `/api/v2` prefix, even before 1.0.
+
+Example:
+
+```bash
+curl -s -X POST http://127.0.0.1:8081/api/v1/query \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "query": {
+      "select": [
+        { "expression": { "measure": "measure.jaffle.revenue_usd" }, "as": "revenue_usd" }
+      ],
+      "group_by": ["dimension.jaffle_store_name"],
+      "time": { "temporal_role": "temporal_role.jaffle_order_time", "grain": "month" },
+      "limit": 5
+    }
+  }'
+```
+
+## Active Scope
+
+- The only supported runtime is `semantic_rails`.
+- The only supported tests are in `tests/semantic_rails`.
+- The active authored package is [configs/semantic_rails/jaffle_shop](configs/semantic_rails/jaffle_shop), the canonical proof package for release-quality metadata, examples, and package-local primitive tests.
+- See [CONTRIBUTING.md](CONTRIBUTING.md) for the active package, metadata, compiler, and fixture paths.
+
+Support tiers, stated plainly: the DuckDB runtime, MCP stdio server, and CLI are the
+supported core — they run in CI on every change. The MetricFlow translator
+([mf2sr/](mf2sr/), behind `semantic-rails import`) ships in the wheel and its tests run in
+every gate, but its surface is younger than the core's. Snowflake execution (Snow CLI and
+native connector) has dialect-level unit coverage but live execution is exercised manually,
+not in CI. The hosted demo is best-effort. This is currently a single-maintainer project;
+support is best-effort via [SUPPORT.md](SUPPORT.md).
+
+## Current Boundaries
+
+- Unsupported mixed-grain paths fail fast with `MIXED_GRAIN_INVALID` or `REWRITE_NOT_SUPPORTED`.
+- Alias resolution returns stable IDs and ambiguity candidates.
+- `build-options` is the primary builder API; `valid-values` searches categorical values for selected dimensions.
+- Supported event-pair conversion metrics execute for the governed event-count model, including same-store variants.
+- The `explain` payload returned by `compile` includes alias resolution, chosen paths, rewrite steps, logical plan, SQL AST, and rendered SQL.
+- Shipped package configs use `expr` AST nodes for measure definitions.
+
+## Relation-Pipeline Claim Boundary
+
+Authored `relation:` pipelines are a compile-time primitive — they let authors
+declare `json_explode`, `date_spine`, `anti_join`, and similar steps that lower into reviewed
+SQL CTEs. There is no runtime SQL pipeline endpoint, no arbitrary CTE compiler, and no
+transformation orchestrator. Shipped capabilities are the evidence-backed surface: package
+models with `relation` metadata, graph entities, semantic joins, measures, metrics,
+`metric_predicate`, supported conversion metrics, segments, Query IR, validation, compile,
+explain (which surfaces `chosen_paths`, `candidates`, and `relationship_contract`), and
+execution.
+
+Semantic Rails is not a general ELT tool, transformation orchestrator, arbitrary CTE
+pipeline compiler, managed materialization service, or unrestricted nested-predicate planner —
+if you need those, pair it with the tools that do them well.
+
+## License
+
+This repository is open source under the Apache License 2.0. See [LICENSE](LICENSE) for the canonical
+terms, [SUPPORT.md](SUPPORT.md) for community support channels, and
+[SECURITY.md](SECURITY.md) for vulnerability reporting.