snowleopard 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

snowleopard/__init__.py

@@ -2,12 +2,12 @@
 # copyright 2025 Snow Leopard, Inc
 # released under the MIT license - see LICENSE file
 
-from snowleopard.async_client import AsyncSnowLeopardPlaygroundClient
-from snowleopard.client import SnowLeopardPlaygroundClient
+from snowleopard.async_client import AsyncSnowLeopardClient
+from snowleopard.client import SnowLeopardClient
 
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 
 __all__ = [
-    "SnowLeopardPlaygroundClient",
-    "AsyncSnowLeopardPlaygroundClient",
+    "SnowLeopardClient",
+    "AsyncSnowLeopardClient",
 ]

snowleopard/async_client.py

@@ -10,7 +10,7 @@ from snowleopard.client_base import SLClientBase
 from snowleopard.models import ResponseDataObjects, RetrieveResponseObjects, parse
 
 
-class AsyncSnowLeopardPlaygroundClient(SLClientBase):
+class AsyncSnowLeopardClient(SLClientBase):
     client: httpx.AsyncClient
 
     def __init__(
@@ -26,9 +26,10 @@ class AsyncSnowLeopardPlaygroundClient(SLClientBase):
 
     async def retrieve(
         self,
-        datafile_id: str,
+        *,
         user_query: str,
         known_data: Optional[Dict[str, Any]] = None,
+        datafile_id: Optional[str] = None,
     ) -> RetrieveResponseObjects:
         resp = await self.client.post(
             url=self._build_path(datafile_id, "retrieve"),
@@ -38,9 +39,10 @@ class AsyncSnowLeopardPlaygroundClient(SLClientBase):
 
     async def response(
         self,
-        datafile_id: str,
-        user_query: str,
+        *,
         known_data: Optional[Dict[str, Any]] = None,
+        user_query: str,
+        datafile_id: Optional[str] = None,
     ) -> AsyncGenerator[ResponseDataObjects, None]:
         async with self.client.stream(
             "POST",

snowleopard/cli.py

@@ -9,7 +9,7 @@ import argparse
 from typing import List, Optional, Dict, Any
 
 from httpx import HTTPStatusError
-from snowleopard import __version__, SnowLeopardPlaygroundClient
+from snowleopard import __version__, SnowLeopardClient
 from snowleopard.models import RetrieveResponseError
 
 
@@ -41,13 +41,15 @@ def _create_parser() -> argparse.ArgumentParser:
     response.set_defaults(command_func=_response)
 
     for subparser in (retrieve, response):
+        subparser.add_argument(
+            "--datafile", "-df", type=str, help="ID for playground datafile to query"
+        )
         subparser.add_argument(
             "--knownData",
             "-d",
             action="append",
             help="Known data in key=value format (can be specified multiple times)",
         )
-        subparser.add_argument("datafile", type=str, help="ID for Datafile to query")
         subparser.add_argument("question", type=str, help="Natural language query")
 
     return parser
@@ -60,7 +62,10 @@ def _parse_known_data(known_data_list: Optional[List[str]]) -> Optional[Dict[str
     result = {}
     for item in known_data_list:
         if "=" not in item:
-            print(f"Error: Invalid knownData format '{item}'. Expected key=value", file=sys.stderr)
+            print(
+                f"Error: Invalid knownData format '{item}'. Expected key=value",
+                file=sys.stderr,
+            )
             sys.exit(1)
         key, value = item.split("=", 1)
         result[key] = value
@@ -69,7 +74,7 @@ def _parse_known_data(known_data_list: Optional[List[str]]) -> Optional[Dict[str
 
 def _get_client(parsed_args):
     try:
-        client = SnowLeopardPlaygroundClient(api_key=parsed_args.apikey, loc=parsed_args.loc)
+        client = SnowLeopardClient(api_key=parsed_args.apikey, loc=parsed_args.loc)
     except Exception as e:
         print(str(e), file=sys.stderr)
         sys.exit(1)
@@ -80,7 +85,11 @@ def _retrieve(parsed_args):
     try:
         known_data = _parse_known_data(parsed_args.knownData)
         with _get_client(parsed_args) as client:
-            resp = client.retrieve(parsed_args.datafile, parsed_args.question, known_data)
+            resp = client.retrieve(
+                user_query=parsed_args.question,
+                known_data=known_data,
+                datafile_id=parsed_args.datafile,
+            )
             print(json.dumps(dataclasses.asdict(resp)))
             if isinstance(resp, RetrieveResponseError):
                 sys.exit(1)
@@ -93,7 +102,11 @@ def _response(parsed_args):
     try:
         known_data = _parse_known_data(parsed_args.knownData)
         with _get_client(parsed_args) as client:
-            for chunk in client.response(parsed_args.datafile, parsed_args.question, known_data):
+            for chunk in client.response(
+                known_data=known_data,
+                user_query=parsed_args.question,
+                datafile_id=parsed_args.datafile,
+            ):
                 print(json.dumps(dataclasses.asdict(chunk)))
     except HTTPStatusError as e:
         print(str(e), file=sys.stderr)

snowleopard/client.py

@@ -10,7 +10,7 @@ from snowleopard.client_base import SLClientBase
 from snowleopard.models import parse, RetrieveResponseObjects, ResponseDataObjects
 
 
-class SnowLeopardPlaygroundClient(SLClientBase):
+class SnowLeopardClient(SLClientBase):
     client: httpx.Client
 
     def __init__(
@@ -26,9 +26,10 @@ class SnowLeopardPlaygroundClient(SLClientBase):
 
     def retrieve(
         self,
-        datafile_id: str,
+        *,
         user_query: str,
         known_data: Optional[Dict[str, Any]] = None,
+        datafile_id: Optional[str] = None,
     ) -> RetrieveResponseObjects:
         resp = self.client.post(
             url=self._build_path(datafile_id, "retrieve"),
@@ -40,9 +41,10 @@ class SnowLeopardPlaygroundClient(SLClientBase):
 
     def response(
         self,
-        datafile_id: str,
-        user_query: str,
+        *,
         known_data: Optional[Dict[str, Any]] = None,
+        user_query: str,
+        datafile_id: Optional[str] = None,
     ) -> Generator[ResponseDataObjects, None, None]:
         with self.client.stream(
             "POST",

snowleopard/client_base.py

@@ -3,6 +3,7 @@
 # released under the MIT license - see LICENSE file
 
 import os
+from abc import abstractmethod
 from dataclasses import dataclass
 from typing import Optional, Dict, Any
 
@@ -25,6 +26,44 @@ class SLConfig:
 
 
 class SLClientBase:
+    @abstractmethod
+    def retrieve(
+        self,
+        *,
+        user_query: str,
+        known_data: Optional[Dict[str, Any]] = None,
+        datafile_id: Optional[str] = None,
+    ):
+        """
+        The primary for developers building AI agents that needs to retrieve data from a database directly.
+
+        Takes a natural language question (usually from the user or the agent) and returns the data required to answer
+        the query in an LLM-friendly object.
+
+        :param datafile_id: (optional) The playground datafile-id if hitting a Snow Leopard api directly
+        :param user_query: Natural language query to execute against the Playground datafile
+        :param known_data: Additional context about the user_query
+        """
+        ...
+
+    @abstractmethod
+    def response(
+        self,
+        *,
+        known_data: Optional[Dict[str, Any]] = None,
+        user_query: str,
+        datafile_id: Optional[str] = None,
+    ):
+        """
+        Takes a natural language question (usually from the user or the agent) and returns the data required to answer
+        the query as well as a LLM summary of the returned data.
+
+        :param datafile_id: (optional) The playground datafile-id if hitting a Snow Leopard api directly
+        :param user_query: Natural language query to execute against the Playground datafile
+        :param known_data: (optional) Additional context about the user_query
+        """
+        ...
+
     @staticmethod
     def _config(
         api_key: Optional[str], timeout: Optional[httpx.Timeout], loc: Optional[str]
@@ -46,7 +85,10 @@ class SLClientBase:
 
     @staticmethod
     def _build_path(datafile_id: str, endpoint: str) -> str:
-        return f"datafiles/{datafile_id}/{endpoint}"
+        if datafile_id is None:
+            return endpoint
+        else:
+            return f"datafiles/{datafile_id}/{endpoint}"
 
     @staticmethod
     def _build_request_body(

snowleopard/models.py

@@ -11,6 +11,7 @@ from typing import Any, Dict, List, Optional, Union
 
 class StrEnum(str, Enum):
     """String enum compatible with Python 3.8"""
+
     pass
 
 

{snowleopard-0.1.1.dist-info → snowleopard-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowleopard
-Version: 0.1.1
+Version: 0.2.0
 Summary: snowleopard.ai client library
 Author-email: Snowy <hello@snowleopard.ai>
 License: MIT License
@@ -34,7 +34,9 @@ Description-Content-Type: text/markdown
 
 # Snow Leopard SDK for Python
 
-Python client library for [Snow Leopard Playground](https://try.snowleopard.ai) APIs.
+This repo contains the Python client library for [Snow Leopard Playground](https://try.snowleopard.ai) APIs. 
+
+See our [API documentation](https://docs.snowleopard.ai/#api-documentation) for more details.
 
 ## Installation
 
@@ -45,16 +47,13 @@ pip install snowleopard
 ## Quick Start
 
 ```python
-from snowleopard import SnowLeopardPlaygroundClient
+from snowleopard import SnowLeopardClient
 
-# Initialize the client (or AsyncSnowLeopardPlaygroundClient)
-client = SnowLeopardPlaygroundClient(api_key="your-api-key")
+# Initialize the client (or AsyncSnowLeopardClient)
+client = SnowLeopardClient(api_key="your-api-key")
 
 # Query your data in natural language
-response = client.retrieve(
-    datafile_id="your-datafile-id",
-    user_query="How many users signed up last month?"
-)
+response = client.retrieve(user_query="How many users signed up last month?", datafile_id="your-datafile-id")
 ```
 
 ## Getting Started
@@ -69,7 +68,7 @@ response = client.retrieve(
     Or pass it directly to the client:
     
     ```python
-    SnowLeopardPlaygroundClient(api_key="your-api-key")
+    SnowLeopardClient(api_key="your-api-key")
     ```
 
 ## Usage
@@ -77,31 +76,31 @@ response = client.retrieve(
 ### Synchronous Client
 
 ```python
-from snowleopard import SnowLeopardPlaygroundClient
+from snowleopard import SnowLeopardClient
 
-with SnowLeopardPlaygroundClient() as client:
-    # Get data directly from a natural language query
-    response = client.retrieve("datafile-id", "What's the total revenue?")
-    print(response.data)
-    
-    # Stream natural language summary of live data
-    for chunk in client.response("datafile-id", "Show me top 10 customers"):
-        print(chunk)
+with SnowLeopardClient() as client:
+   # Get data directly from a natural language query
+   response = client.retrieve(user_query="How many superheroes are there?")
+   print(response.data)
+
+   # Stream natural language summary of live data
+   for chunk in client.response(user_query="How many superheroes are there?"):
+      print(chunk)
 ```
 
 ### Async Client
 
 ```python
-from snowleopard import AsyncSnowLeopardPlaygroundClient
+from snowleopard import AsyncSnowLeopardClient
 
-async with AsyncSnowLeopardPlaygroundClient() as client:
-    # Get complete results
-    response = await client.retrieve("datafile-id", "What's the total revenue?")
-    print(response.data)
+async with AsyncSnowLeopardClient() as client:
+   # Get complete results
+   response = await client.retrieve(user_query="How many superheroes are there?")
+   print(response.data)
 
-    # Get streaming results
-    async for chunk in client.response("datafile-id", "Show me top 10 customers"):
-        print(chunk)
+   # Get streaming results
+   async for chunk in client.response(user_query="How many superheroes are there?"):
+      print(chunk)
 ```
 
 ### CLI
@@ -110,10 +109,22 @@ The SDK includes a command-line interface:
 
 ```bash
 pip install snowleopard
-snowy retrieve <datafile-id> "How many records are there?"
-snowy response <datafile-id> "Summarize the data"
+snowy retrieve --datafile <datafile-id> "How many records are there?"
+snowy response --datafile <datafile-id> "Summarize the data"
 ```
 
+### On Premise Customers
+
+For our customers who have a separate deployment per dataset, you should declare <url> explicitly when creating a 
+client and omit <datafile id> when querying.
+
+Example:
+```python
+client = SnowLeopardClient(url="https://{your-vm-ip}:{port}", api_key="your-api-key")
+response = client.retrieve(user_query="How many users signed up last month?")
+```
+
+
 ## Contributing
 
 For SDK developer docs and how to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md)

snowleopard-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+snowleopard/__init__.py,sha256=q2PBrFC6njiGSnk2apaohSpWbvTFFoiV5Aup9D3u3_U,314
+snowleopard/async_client.py,sha256=IqWpv5CCYwGtuWAGMHFE4dInP6l643WePTEWvytSCsg,1994
+snowleopard/cli.py,sha256=0fXljUETy2RhC2kfuvhk-DKORvWYz0Zm_AUWuqrf1EY,3968
+snowleopard/client.py,sha256=YnnCkAdPzumckxhm_DiL2uVsUP9RF_P8ILMZDUF-tlY,1990
+snowleopard/client_base.py,sha256=hLmtd6W_wuHp-oh5dTAzpEyRkniyuyho_qJy4-k6cdE,3468
+snowleopard/models.py,sha256=A3dFN4X9h31rK-OObvBYJklCgrOdiLpgWZH0L_liak0,2859
+snowleopard-0.2.0.dist-info/METADATA,sha256=rlQZtSsoKk9BtKcTsAAHbIUIZr7h5LWakXyv84sPTBc,4223
+snowleopard-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+snowleopard-0.2.0.dist-info/entry_points.txt,sha256=KoByMlsBKmDB6_iwkrTCFyl2BT9bjBuKUZth40aXx70,47
+snowleopard-0.2.0.dist-info/licenses/LICENSE,sha256=Lw8Ah-T2MngQlqtV8GCML7qD1OPJ5QnccfJBB_U3f2A,1072
+snowleopard-0.2.0.dist-info/RECORD,,

{snowleopard-0.1.1.dist-info → snowleopard-0.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

snowleopard-0.1.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-snowleopard/__init__.py,sha256=bN7CK0iAiVg6get_gDBW47JWYzwJ83AZzeVf1bTc_II,354
-snowleopard/async_client.py,sha256=ybTkgqO5SUHq8K0QJbrsvyzZQxlmecjExfacOF4PR2U,1948
-snowleopard/cli.py,sha256=xb1DlP2nm-pkiH4I4U0fHko06yaQZnOwIhjn2tIvc7Y,3705
-snowleopard/client.py,sha256=-oVa7yegfVgJ2p7DVCZhTdA6DOs_Rs69mryCNsH9p6I,1944
-snowleopard/client_base.py,sha256=7hoFmnCfeC1fcBMoOYKVmniSUqsWhe5moGUhlhqf_lo,1903
-snowleopard/models.py,sha256=5kFRjfwe79Cx6tYneLMWKloyGQylYc2pPHoFcwO3GlU,2858
-snowleopard-0.1.1.dist-info/METADATA,sha256=01OaSIIMjzC8jSY-x6yMKNhsOQAPyA3nVuae58mARQY,3804
-snowleopard-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-snowleopard-0.1.1.dist-info/entry_points.txt,sha256=KoByMlsBKmDB6_iwkrTCFyl2BT9bjBuKUZth40aXx70,47
-snowleopard-0.1.1.dist-info/licenses/LICENSE,sha256=Lw8Ah-T2MngQlqtV8GCML7qD1OPJ5QnccfJBB_U3f2A,1072
-snowleopard-0.1.1.dist-info/RECORD,,