groundedql 0.3.0__tar.gz

groundedql-0.3.0/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing To GroundedQL
+
+Thank you for contributing to GroundedQL. Contributions are proposed through pull requests
+and become part of the official project only after maintainer review and merge.
+
+## Before Opening A Pull Request
+
+1. Open or review an issue for substantial changes.
+2. Keep changes focused and consistent with the existing architecture.
+3. Add tests that describe the general capability being changed.
+4. Run the relevant checks locally.
+
+```bash
+pip install -e ".[dev]"
+ruff check groundedql/
+python test/test_main.py lint
+python test/test_generic_planner_resolution.py
+```
+
+## Generality Requirement
+
+GroundedQL uses benchmarks to reveal missing general capabilities. Core logic must not branch
+on benchmark case IDs, benchmark domains, known questions, entity names, or expected
+answers.
+
+A benchmark-driven change should:
+
+- explain the reusable semantic capability;
+- include domain-neutral regression coverage;
+- preserve previously correct behavior;
+- document ambiguity that cannot be resolved safely.
+
+## Pull Request Review
+
+The lead maintainer reviews and decides whether to merge pull requests into the official
+repository. Opening a pull request does not grant merge, maintainer, or release authority.
+
+Review may request changes for correctness, scope, maintainability, security, test coverage,
+or alignment with project direction.
+
+## Releases
+
+Contributors should not publish packages or releases using the official GroundedQL project
+identity. Official GitHub releases, tags, and PyPI publications are handled only by the lead
+maintainer. See [GOVERNANCE.md](GOVERNANCE.md).
+
+## License
+
+By submitting a contribution for inclusion, you agree that it may be distributed under the
+project's Apache License 2.0, consistent with the contribution terms in that license.

groundedql-0.3.0/GOVERNANCE.md

@@ -0,0 +1,31 @@
+# Governance
+
+GroundedQL is an open-source project led and maintained by Alexander Abakah.
+
+## Lead Maintainer
+
+The lead maintainer has final authority over the official GroundedQL project, including:
+
+- reviewing, accepting, and merging pull requests;
+- setting the project roadmap and contribution policies;
+- managing the official `Certifore/groundedql` repository;
+- creating official GitHub releases and release tags;
+- publishing the official `groundedql` package to PyPI;
+- managing project infrastructure and security disclosures.
+
+Contributors may propose changes through issues and pull requests. A contribution becomes
+part of the official project only after it is reviewed and merged by the lead maintainer.
+Repository access or prior contribution does not grant merge or release authority.
+
+## Official Releases
+
+Only the lead maintainer may publish an official GroundedQL release, create an official
+release tag, or publish the official `groundedql` package to PyPI.
+
+The Apache License 2.0 permits forks and redistribution under its terms. Forks and modified
+distributions must not represent themselves as official GroundedQL releases.
+
+## Changes To Governance
+
+The lead maintainer may update this governance model as the project grows. Material changes
+will be documented in the official repository.

groundedql-0.3.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 [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.

groundedql-0.3.0/MANIFEST.in

@@ -0,0 +1,15 @@
+include README.md
+include LICENSE
+include NOTICE
+include CONTRIBUTING.md
+include GOVERNANCE.md
+include SECURITY.md
+include ROADMAP.md
+include MIGRATION.md
+
+exclude config/schema.yaml
+exclude config/queryplan_spec.yaml
+exclude config/queryplan_spec_generated.yaml
+prune config
+prune test
+prune tests

groundedql-0.3.0/MIGRATION.md

@@ -0,0 +1,51 @@
+# Migrating To GroundedQL
+
+IntentQL was renamed to GroundedQL before its broader open-source launch because another
+product already used the IntentQL name.
+
+GroundedQL `0.3.0` is the first release under the new identity. The compiler architecture,
+QueryPlan format, and schema format remain the same.
+
+## Package And Imports
+
+```bash
+pip uninstall intentql
+pip install groundedql
+```
+
+Update Python imports:
+
+```python
+# Before
+from intentql import QueryAgent
+
+# After
+from groundedql import QueryAgent
+```
+
+## Command-Line Interface
+
+Replace the `intentql` command with `groundedql`:
+
+```bash
+groundedql --help
+groundedql init --db "postgresql://user:pass@host/db"
+```
+
+## Optional Memory Configuration
+
+The optional memory feature now reads:
+
+- `GROUNDEDQL_DISABLE_MEMORY`
+- `GROUNDEDQL_MEMORY_MIN_SIMILARITY`
+- `GROUNDEDQL_MEMORY_TASK_FILTER`
+
+Its default local state directory changed from `~/.intentql/intent_memory` to
+`~/.groundedql/intent_memory`. Move that directory manually if you want to retain existing
+few-shot memory.
+
+## Local Ollama Model
+
+The default local model name changed from `intentql-gemma4` to `groundedql-gemma4`. Set
+`OLLAMA_MODEL` explicitly if you want to continue using an existing model under its old
+local name.

groundedql-0.3.0/NOTICE

@@ -0,0 +1,4 @@
+GroundedQL
+Copyright 2026 Alexander Abakah
+
+This product includes software developed by Alexander Abakah and GroundedQL contributors.

groundedql-0.3.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: groundedql
+Version: 0.3.0
+Summary: GroundedQL — Intent-driven, deterministic natural language to SQL for Postgres.
+Author: Alexander Abakah
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Certifore/groundedql
+Project-URL: Documentation, https://certifore.github.io/groundedql_docs
+Project-URL: Repository, https://github.com/Certifore/groundedql
+Project-URL: Issues, https://github.com/Certifore/groundedql/issues
+Keywords: sql,intent,grounded,postgres,sqlalchemy,llm,analytics,natural-language,text-to-sql
+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: Operating System :: OS Independent
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: psycopg2-binary
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml
+Provides-Extra: memory
+Requires-Dist: chromadb>=0.4; extra == "memory"
+Provides-Extra: openai
+Requires-Dist: openai>=1.0; extra == "openai"
+Provides-Extra: google
+Requires-Dist: google-generativeai>=0.5.0; extra == "google"
+Provides-Extra: benchmark
+Requires-Dist: langchain-openai>=0.2; extra == "benchmark"
+Requires-Dist: langchain-google-genai>=2.0; extra == "benchmark"
+Requires-Dist: langchain-community>=0.3; extra == "benchmark"
+Requires-Dist: python-dotenv; extra == "benchmark"
+Provides-Extra: dev
+Requires-Dist: ruff>=0.6.0; extra == "dev"
+Requires-Dist: build>=1.2.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+Dynamic: license-file
+
+# GroundedQL
+
+![GroundedQL - Reliable natural-language analytics through deterministic SQL compilation](assets/groundedql-social-preview.png)
+
+Intent-driven, deterministic natural language to SQL for Postgres.  
+Instead of letting an LLM generate free-form SQL, the LLM extracts a lightweight **QueryIntent**, and GroundedQL deterministically compiles it into parameterized SQL and executes it safely.
+
+## Install
+
+```bash
+pip install groundedql
+```
+
+To use the OpenAI SDK adapter shown below:
+
+```bash
+pip install "groundedql[openai]"
+```
+
+With optional few-shot memory (recommended for production):
+
+```bash
+pip install "groundedql[memory]"
+```
+
+<details>
+<summary>Install from source</summary>
+
+```bash
+git clone https://github.com/Certifore/groundedql
+cd groundedql
+pip install -e ".[dev]"
+```
+</details>
+
+## Quick Start
+
+### 1. Generate your schema from the database
+
+```bash
+groundedql init --db "postgresql://user:pass@host/db"
+# → config/schema.yaml  (tables, columns, types, PKs, links — all auto-detected)
+```
+
+### 2. Enrich with LLM-generated descriptions (optional, recommended)
+
+```bash
+export LLM_API_KEY=sk-...   # works with any OpenAI-compatible provider
+groundedql describe --schema config/schema.yaml --db "postgresql://user:pass@host/db"
+# → Adds table + column descriptions using sample data for context
+```
+
+### 3. Ask questions
+
+```python
+from sqlalchemy import create_engine
+from openai import OpenAI
+from groundedql.agent import QueryAgent
+
+engine = create_engine("postgresql+psycopg2://user:pass@host/db")
+
+agent = QueryAgent(
+    engine=engine,
+    schema_path="config/schema.yaml",
+    llm=OpenAI(api_key="sk-..."),
+)
+
+result = agent.ask("how many plumbing issues last year?")
+print(result["rows"])
+print(result["sql"])
+```
+
+### Use Mistral instead of OpenAI
+
+```bash
+export MISTRAL_AI=...
+# optional
+export MISTRAL_MODEL=mistral-small-latest
+```
+
+```python
+agent = QueryAgent(
+    engine=engine,
+    schema_path="config/schema.yaml",
+    llm="mistral",  # or "mistral:mistral-small-latest"
+)
+```
+
+### Use a local Ollama model
+
+```bash
+export OLLAMA_MODEL=groundedql-gemma4
+# optional
+export OLLAMA_BASE_URL=http://127.0.0.1:11434
+export OLLAMA_NUM_CTX=8192
+```
+
+```python
+agent = QueryAgent(
+    engine=engine,
+    schema_path="config/schema.yaml",
+    llm="ollama",  # or "ollama:groundedql-gemma4"
+)
+```
+
+## CLI Reference
+
+| Command | Description |
+|---|---|
+| `groundedql init --db URL` | Introspect Postgres and generate `schema.yaml` |
+| `groundedql describe --schema PATH --db URL` | Enrich schema with LLM-generated descriptions |
+
+Run `groundedql --help` for full options.
+
+## Documentation
+
+Full documentation, benchmarks, and guides are at [certifore.github.io/groundedql_docs](https://certifore.github.io/groundedql_docs) ([source](https://github.com/Certifore/groundedql_docs)).
+
+See [ROADMAP.md](ROADMAP.md) for planned capabilities (lookup, trends, ratios, multi-step NL, and expressiveness goals).
+
+Existing users of the previous package name should read [MIGRATION.md](MIGRATION.md).
+
+## Contributing
+
+Contributions are welcome through pull requests. Please read
+[CONTRIBUTING.md](CONTRIBUTING.md) before submitting changes. The lead maintainer reviews
+and merges all changes into the official repository and is the only person who publishes
+official releases.
+
+## License
+
+GroundedQL is licensed under the [Apache License 2.0](LICENSE).

groundedql-0.3.0/README.md

@@ -0,0 +1,132 @@
+# GroundedQL
+
+![GroundedQL - Reliable natural-language analytics through deterministic SQL compilation](assets/groundedql-social-preview.png)
+
+Intent-driven, deterministic natural language to SQL for Postgres.  
+Instead of letting an LLM generate free-form SQL, the LLM extracts a lightweight **QueryIntent**, and GroundedQL deterministically compiles it into parameterized SQL and executes it safely.
+
+## Install
+
+```bash
+pip install groundedql
+```
+
+To use the OpenAI SDK adapter shown below:
+
+```bash
+pip install "groundedql[openai]"
+```
+
+With optional few-shot memory (recommended for production):
+
+```bash
+pip install "groundedql[memory]"
+```
+
+<details>
+<summary>Install from source</summary>
+
+```bash
+git clone https://github.com/Certifore/groundedql
+cd groundedql
+pip install -e ".[dev]"
+```
+</details>
+
+## Quick Start
+
+### 1. Generate your schema from the database
+
+```bash
+groundedql init --db "postgresql://user:pass@host/db"
+# → config/schema.yaml  (tables, columns, types, PKs, links — all auto-detected)
+```
+
+### 2. Enrich with LLM-generated descriptions (optional, recommended)
+
+```bash
+export LLM_API_KEY=sk-...   # works with any OpenAI-compatible provider
+groundedql describe --schema config/schema.yaml --db "postgresql://user:pass@host/db"
+# → Adds table + column descriptions using sample data for context
+```
+
+### 3. Ask questions
+
+```python
+from sqlalchemy import create_engine
+from openai import OpenAI
+from groundedql.agent import QueryAgent
+
+engine = create_engine("postgresql+psycopg2://user:pass@host/db")
+
+agent = QueryAgent(
+    engine=engine,
+    schema_path="config/schema.yaml",
+    llm=OpenAI(api_key="sk-..."),
+)
+
+result = agent.ask("how many plumbing issues last year?")
+print(result["rows"])
+print(result["sql"])
+```
+
+### Use Mistral instead of OpenAI
+
+```bash
+export MISTRAL_AI=...
+# optional
+export MISTRAL_MODEL=mistral-small-latest
+```
+
+```python
+agent = QueryAgent(
+    engine=engine,
+    schema_path="config/schema.yaml",
+    llm="mistral",  # or "mistral:mistral-small-latest"
+)
+```
+
+### Use a local Ollama model
+
+```bash
+export OLLAMA_MODEL=groundedql-gemma4
+# optional
+export OLLAMA_BASE_URL=http://127.0.0.1:11434
+export OLLAMA_NUM_CTX=8192
+```
+
+```python
+agent = QueryAgent(
+    engine=engine,
+    schema_path="config/schema.yaml",
+    llm="ollama",  # or "ollama:groundedql-gemma4"
+)
+```
+
+## CLI Reference
+
+| Command | Description |
+|---|---|
+| `groundedql init --db URL` | Introspect Postgres and generate `schema.yaml` |
+| `groundedql describe --schema PATH --db URL` | Enrich schema with LLM-generated descriptions |
+
+Run `groundedql --help` for full options.
+
+## Documentation
+
+Full documentation, benchmarks, and guides are at [certifore.github.io/groundedql_docs](https://certifore.github.io/groundedql_docs) ([source](https://github.com/Certifore/groundedql_docs)).
+
+See [ROADMAP.md](ROADMAP.md) for planned capabilities (lookup, trends, ratios, multi-step NL, and expressiveness goals).
+
+Existing users of the previous package name should read [MIGRATION.md](MIGRATION.md).
+
+## Contributing
+
+Contributions are welcome through pull requests. Please read
+[CONTRIBUTING.md](CONTRIBUTING.md) before submitting changes. The lead maintainer reviews
+and merges all changes into the official repository and is the only person who publishes
+official releases.
+
+## License
+
+GroundedQL is licensed under the [Apache License 2.0](LICENSE).