piglets 0.1.0__py3-none-any.whl

piglets/__init__.py

@@ -0,0 +1,7 @@
+from .planning import LogicalPlanner as LogicalPlanner
+from .types import LogicalPlan as LogicalPlan
+
+__all__ = [
+    "LogicalPlan",
+    "LogicalPlanner",
+]

piglets/planning/__init__.py

@@ -0,0 +1,5 @@
+from .logical_planning import LogicalPlanner as LogicalPlanner
+
+__all__ = [
+    "LogicalPlanner"
+]

piglets/planning/logical_planning/__init__.py

@@ -0,0 +1,5 @@
+from .logical_planner import LogicalPlanner as LogicalPlanner
+
+__all__ = [
+    "LogicalPlanner"
+]

piglets/planning/logical_planning/logical_planner.py

@@ -0,0 +1,17 @@
+from pathlib import Path
+from langchain.chat_models import init_chat_model
+
+from piglets.types import LogicalPlan
+from piglets.utils import read_markdown_file
+
+class LogicalPlanner():
+    def __init__(self, model_name: str):
+        file_path = Path(__file__).with_suffix(".md").resolve()
+        self.system_instruction = read_markdown_file(file_path=file_path)
+
+        llm = init_chat_model(model_name)
+        llm = llm.with_structured_output(LogicalPlan)
+        self.llm = llm
+
+    def plan(self, natural_language_query: str) -> LogicalPlan:
+        return self.llm.invoke(f"{self.system_instruction} \nUser question: {natural_language_query}")

piglets/types/__init__.py

@@ -0,0 +1,5 @@
+from .plans import LogicalPlan as LogicalPlan
+
+__all__ = [
+    "LogicalPlan"
+]

piglets/types/plans.py

@@ -0,0 +1,5 @@
+from typing import TypedDict
+
+class LogicalPlan(TypedDict):
+    """A logical plan for how to answer a natural language query."""
+    logical_steps: list[str]

piglets/utils/__init__.py

@@ -0,0 +1,5 @@
+from .mardown_handling import read_markdown_file as read_markdown_file
+
+__all__ = [
+    "read_markdown_file"
+]

piglets/utils/mardown_handling.py

@@ -0,0 +1,4 @@
+from pathlib import Path
+
+def read_markdown_file(file_path: Path) -> str:
+    return file_path.read_text(encoding="utf-8")

piglets-0.1.0.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: piglets
+Version: 0.1.0
+Summary: A modular text-to-SQL toolkit.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: langchain>=1.0
+Provides-Extra: openai
+Requires-Dist: langchain-openai>=1.0; extra == "openai"
+
+# 🐷 piglets
+
+A modular, pre-1.0 library of text-to-SQL planning tools.
+
+## Status
+
+`piglets` is currently an **alpha-stage** package. The API is expected to evolve before `1.0`.
+
+## Current scope
+
+### Planning
+
+The first included primitive is a `LogicalPlanner` that turns a natural-language analytics question into an ordered list of abstract logical steps.
+
+This keeps planning at the business-logic level before later schema grounding or SQL generation.
+
+### Pruning
+
+Pruning components are planned but not included yet.

piglets-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+piglets/__init__.py,sha256=PNNFVoGd4R6yNvSV-2TdS2cei2QXprgswqL9vl0X5O4,156
+piglets/planning/__init__.py,sha256=nTwVulVR7jQ7I5TTGdtDxfFodC46WdGYFVEIbJY3-uo,98
+piglets/planning/logical_planning/__init__.py,sha256=KLKNsvhraKn3tscwMmJUHZtOnlfIz6LflR6jm3OMYAg,97
+piglets/planning/logical_planning/logical_planner.py,sha256=rRolhxVDsgH285BDLEP4rncRVFDzIc_a0KpUrXXYOC0,650
+piglets/types/__init__.py,sha256=vb57W3R4JjAg5T4a3XBzzuSyFSnpJjg64U3pv5q4ydk,78
+piglets/types/plans.py,sha256=gJ8DN9WJrdwWrZnynj4LbD63TorieiN7btBuHiyOtAw,157
+piglets/utils/__init__.py,sha256=ApkNLewpgD17MEm88OaaKRpOxPFYSoMJFc6bKy-y_y8,110
+piglets/utils/mardown_handling.py,sha256=Omwh9jJshutRaj2WCCjgpdmHNjwLSrpH7Je3exnnGiE,123
+piglets-0.1.0.dist-info/METADATA,sha256=B6GbPsXbHXXIdMzC-af4S_njJr4EXpdjKI9zZldz0HU,792
+piglets-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+piglets-0.1.0.dist-info/top_level.txt,sha256=9jlI4jWtCYTI5JQRBreB3QgYSdULNisQGqhjyA24M0A,8
+piglets-0.1.0.dist-info/RECORD,,

piglets-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

piglets-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+piglets