piglets 0.1.0__tar.gz

piglets-0.1.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,19 @@
+# 🐷 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/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "piglets"
+version = "0.1.0"
+description = "A modular text-to-SQL toolkit."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "langchain>=1.0",
+]
+
+[project.optional-dependencies]
+openai = [
+    "langchain-openai>=1.0",
+]
+
+[dependency-groups]
+dev = [
+    "build>=1.4.3",
+    "twine>=6.2.0",
+]
+test = [
+    "pytest>=8.0",
+    "langchain-openai>=1.0"
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["-ra"]

piglets-0.1.0/setup.cfg

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

piglets-0.1.0/src/piglets/__init__.py

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

piglets-0.1.0/src/piglets/planning/__init__.py

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

piglets-0.1.0/src/piglets/planning/logical_planning/__init__.py

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

piglets-0.1.0/src/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-0.1.0/src/piglets/types/__init__.py

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

piglets-0.1.0/src/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-0.1.0/src/piglets/utils/__init__.py

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

piglets-0.1.0/src/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/src/piglets.egg-info/PKG-INFO

@@ -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/src/piglets.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+src/piglets/__init__.py
+src/piglets.egg-info/PKG-INFO
+src/piglets.egg-info/SOURCES.txt
+src/piglets.egg-info/dependency_links.txt
+src/piglets.egg-info/requires.txt
+src/piglets.egg-info/top_level.txt
+src/piglets/planning/__init__.py
+src/piglets/planning/logical_planning/__init__.py
+src/piglets/planning/logical_planning/logical_planner.py
+src/piglets/types/__init__.py
+src/piglets/types/plans.py
+src/piglets/utils/__init__.py
+src/piglets/utils/mardown_handling.py

piglets-0.1.0/src/piglets.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

piglets-0.1.0/src/piglets.egg-info/requires.txt

@@ -0,0 +1,4 @@
+langchain>=1.0
+
+[openai]
+langchain-openai>=1.0

piglets-0.1.0/src/piglets.egg-info/top_level.txt

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