definite-sdk 0.1.8__tar.gz → 0.1.11__tar.gz

{definite_sdk-0.1.8 → definite_sdk-0.1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: definite-sdk
-Version: 0.1.8
+Version: 0.1.11
 Summary: Definite SDK for Python
 License: MIT
 Author: Definite
@@ -21,7 +21,7 @@ Description-Content-Type: text/markdown
 
 # Definite SDK
 
-A Python client for interacting with the Definite API, providing a convenient interface for key-value store operations, SQL query execution, secrets management, and DLT (Data Load Tool) integration with state persistence.
+A Python client for interacting with the Definite API, providing a convenient interface for key-value store operations, SQL query execution, secrets management, messaging capabilities, and DLT (Data Load Tool) integration with state persistence.
 
 ## Installation
 
@@ -57,7 +57,9 @@ client = DefiniteClient("YOUR_API_KEY")
 - **Cube Query Execution**: Execute Cube queries for advanced analytics and data modeling
 - **Secret Management**: Secure storage and retrieval of application secrets
 - **Integration Store**: Read-only access to integration configurations
+- **Messaging**: Send messages through various channels (Slack, and more coming soon)
 - **dlt Integration**: Run dlt pipelines with automatic state persistence to Definite
+- **DuckLake Integration**: Easy attachment of your team's DuckLake to DuckDB connections
 - **DuckDB Support**: Automatic discovery and connection to team's DuckDB integrations
 
 ## Basic Usage
@@ -167,6 +169,49 @@ integrations = list(integration_store.list_integrations())
 integration = integration_store.get_integration("my_integration")
 ```
 
+### 💬 Messaging
+
+Send messages through various channels using the messaging client.
+
+```python
+# Initialize the message client
+message_client = client.get_message_client()
+# Or use the alias method
+message_client = client.message_client()
+
+# Send a Slack message using the unified interface
+result = message_client.send_message(
+    channel="slack",
+    integration_id="your_slack_integration_id",
+    to="C0920MVPWFN",  # Slack channel ID
+    content="Hello from Definite SDK! 👋"
+)
+
+# Send a Slack message with blocks and threading
+result = message_client.send_message(
+    channel="slack",
+    integration_id="your_slack_integration_id",
+    to="C0920MVPWFN",
+    content="Fallback text",
+    blocks=[{
+        "type": "section",
+        "text": {"type": "mrkdwn", "text": "*Important Update*"}
+    }],
+    thread_ts="1234567890.123456"  # Reply in thread
+)
+
+# Or use the convenience method for Slack
+result = message_client.send_slack_message(
+    integration_id="your_slack_integration_id",
+    channel_id="C0920MVPWFN",
+    text="Quick message using the convenience method!",
+    blocks=[{
+        "type": "section",
+        "text": {"type": "mrkdwn", "text": "Message with *rich* _formatting_"}
+    }]
+)
+```
+
 ### dlt Integration
 
 ```python
@@ -187,6 +232,39 @@ pipeline.run(orders())
 last_cursor = pipeline.get_state("orders")
 ```
 
+### DuckLake Integration
+
+Attach your team's DuckLake to a DuckDB connection for seamless data access:
+
+```python
+import duckdb
+from definite_sdk import DefiniteClient
+
+# Initialize the client
+client = DefiniteClient("YOUR_API_KEY")
+
+# Connect to DuckDB and attach DuckLake
+conn = duckdb.connect()
+conn.execute(client.attach_ducklake())
+
+# Now you can use DuckLake tables
+conn.execute("CREATE SCHEMA IF NOT EXISTS lake.my_schema;")
+conn.execute("CREATE OR REPLACE TABLE lake.my_schema.users AS SELECT * FROM df")
+
+# Query your DuckLake data
+result = conn.sql("SELECT * FROM lake.my_schema.users").df()
+```
+
+You can also specify a custom alias for the attached DuckLake:
+
+```python
+# Attach with custom alias
+conn.execute(client.attach_ducklake(alias="warehouse"))
+
+# Use the custom alias
+conn.execute("SELECT * FROM warehouse.my_schema.users")
+```
+
 ### DuckDB Integration Discovery
 
 ```python

{definite_sdk-0.1.8 → definite_sdk-0.1.11}/README.md

@@ -1,6 +1,6 @@
 # Definite SDK
 
-A Python client for interacting with the Definite API, providing a convenient interface for key-value store operations, SQL query execution, secrets management, and DLT (Data Load Tool) integration with state persistence.
+A Python client for interacting with the Definite API, providing a convenient interface for key-value store operations, SQL query execution, secrets management, messaging capabilities, and DLT (Data Load Tool) integration with state persistence.
 
 ## Installation
 
@@ -36,7 +36,9 @@ client = DefiniteClient("YOUR_API_KEY")
 - **Cube Query Execution**: Execute Cube queries for advanced analytics and data modeling
 - **Secret Management**: Secure storage and retrieval of application secrets
 - **Integration Store**: Read-only access to integration configurations
+- **Messaging**: Send messages through various channels (Slack, and more coming soon)
 - **dlt Integration**: Run dlt pipelines with automatic state persistence to Definite
+- **DuckLake Integration**: Easy attachment of your team's DuckLake to DuckDB connections
 - **DuckDB Support**: Automatic discovery and connection to team's DuckDB integrations
 
 ## Basic Usage
@@ -146,6 +148,49 @@ integrations = list(integration_store.list_integrations())
 integration = integration_store.get_integration("my_integration")
 ```
 
+### 💬 Messaging
+
+Send messages through various channels using the messaging client.
+
+```python
+# Initialize the message client
+message_client = client.get_message_client()
+# Or use the alias method
+message_client = client.message_client()
+
+# Send a Slack message using the unified interface
+result = message_client.send_message(
+    channel="slack",
+    integration_id="your_slack_integration_id",
+    to="C0920MVPWFN",  # Slack channel ID
+    content="Hello from Definite SDK! 👋"
+)
+
+# Send a Slack message with blocks and threading
+result = message_client.send_message(
+    channel="slack",
+    integration_id="your_slack_integration_id",
+    to="C0920MVPWFN",
+    content="Fallback text",
+    blocks=[{
+        "type": "section",
+        "text": {"type": "mrkdwn", "text": "*Important Update*"}
+    }],
+    thread_ts="1234567890.123456"  # Reply in thread
+)
+
+# Or use the convenience method for Slack
+result = message_client.send_slack_message(
+    integration_id="your_slack_integration_id",
+    channel_id="C0920MVPWFN",
+    text="Quick message using the convenience method!",
+    blocks=[{
+        "type": "section",
+        "text": {"type": "mrkdwn", "text": "Message with *rich* _formatting_"}
+    }]
+)
+```
+
 ### dlt Integration
 
 ```python
@@ -166,6 +211,39 @@ pipeline.run(orders())
 last_cursor = pipeline.get_state("orders")
 ```
 
+### DuckLake Integration
+
+Attach your team's DuckLake to a DuckDB connection for seamless data access:
+
+```python
+import duckdb
+from definite_sdk import DefiniteClient
+
+# Initialize the client
+client = DefiniteClient("YOUR_API_KEY")
+
+# Connect to DuckDB and attach DuckLake
+conn = duckdb.connect()
+conn.execute(client.attach_ducklake())
+
+# Now you can use DuckLake tables
+conn.execute("CREATE SCHEMA IF NOT EXISTS lake.my_schema;")
+conn.execute("CREATE OR REPLACE TABLE lake.my_schema.users AS SELECT * FROM df")
+
+# Query your DuckLake data
+result = conn.sql("SELECT * FROM lake.my_schema.users").df()
+```
+
+You can also specify a custom alias for the attached DuckLake:
+
+```python
+# Attach with custom alias
+conn.execute(client.attach_ducklake(alias="warehouse"))
+
+# Use the custom alias
+conn.execute("SELECT * FROM warehouse.my_schema.users")
+```
+
 ### DuckDB Integration Discovery
 
 ```python

{definite_sdk-0.1.8 → definite_sdk-0.1.11}/definite_sdk/__init__.py

@@ -6,14 +6,16 @@ A Python library for interacting with the Definite API and tools.
 
 from definite_sdk.client import DefiniteClient
 from definite_sdk.integration import DefiniteIntegrationStore
+from definite_sdk.message import DefiniteMessageClient
 from definite_sdk.secret import DefiniteSecretStore
 from definite_sdk.sql import DefiniteSqlClient
 from definite_sdk.store import DefiniteKVStore
 
-__version__ = "0.1.8"
+__version__ = "0.1.9"
 __all__ = [
     "DefiniteClient",
     "DefiniteIntegrationStore",
+    "DefiniteMessageClient",
     "DefiniteSecretStore",
     "DefiniteSqlClient",
     "DefiniteKVStore",

{definite_sdk-0.1.8 → definite_sdk-0.1.11}/definite_sdk/client.py

@@ -1,7 +1,9 @@
 import os
 from typing import Optional
 
+import requests
 from definite_sdk.integration import DefiniteIntegrationStore
+from definite_sdk.message import DefiniteMessageClient
 from definite_sdk.secret import DefiniteSecretStore
 from definite_sdk.sql import DefiniteSqlClient
 from definite_sdk.store import DefiniteKVStore
@@ -65,6 +67,55 @@ class DefiniteClient:
 
         return DefiniteSqlClient(self.api_key, self.api_url)
 
+    def attach_ducklake(self, alias: str = "lake") -> str:
+        """Generates SQL statements to attach DuckLake to a DuckDB connection.
+        
+        This method fetches the team's DuckLake integration credentials and generates
+        the necessary SQL statements to create a GCS secret and attach DuckLake.
+        
+        Args:
+            alias: The alias name for the attached DuckLake database (default: "lake")
+            
+        Returns:
+            str: SQL statements to execute for attaching DuckLake
+            
+        Example:
+            >>> client = DefiniteClient(os.environ["DEFINITE_API_KEY"])
+            >>> sql = client.attach_ducklake()
+            >>> conn.execute(sql)
+        """
+        # Fetch DuckLake integration details
+        response = requests.get(
+            f"{self.api_url}/v1/api/integration/DuckLake",
+            headers={"Authorization": f"Bearer {self.api_key}"},
+        )
+        response.raise_for_status()
+        dl_integration = response.json()
+        
+        # Generate SQL statements
+        create_secret_sql = f"""CREATE SECRET (
+    TYPE gcs,
+    KEY_ID '{dl_integration['gcs_access_key_id']}',
+    SECRET '{dl_integration['gcs_secret_access_key']}'
+);"""
+        
+        # Build PostgreSQL connection string
+        pg_conn_str = (
+            f"postgresql://{dl_integration['pg_user']}:"
+            f"{dl_integration['pg_password']}@"
+            f"{dl_integration['pg_host']}:"
+            f"{dl_integration['pg_port']}/"
+            f"{dl_integration['pg_database']}"
+        )
+        
+        attach_sql = (
+            f"ATTACH 'ducklake:postgres:{pg_conn_str}' AS {alias} "
+            f"(DATA_PATH 'gs://{dl_integration['gcs_bucket_path']}', "
+            f"METADATA_SCHEMA '{dl_integration['pg_schema']}');"
+        )
+        
+        return f"{create_secret_sql}\n\n{attach_sql}"
+
     # Alias methods for consistency
     def kv_store(self, name: str) -> DefiniteKVStore:
         """Alias for get_kv_store."""
@@ -77,3 +128,15 @@ class DefiniteClient:
     def integration_store(self) -> DefiniteIntegrationStore:
         """Alias for get_integration_store."""
         return self.get_integration_store()
+
+    def get_message_client(self) -> DefiniteMessageClient:
+        """Initializes the message client for sending messages via various channels.
+
+        See DefiniteMessageClient for more how to send messages.
+        """
+
+        return DefiniteMessageClient(self.api_key, self.api_url)
+
+    def message_client(self) -> DefiniteMessageClient:
+        """Alias for get_message_client."""
+        return self.get_message_client()

definite_sdk-0.1.11/definite_sdk/message.py

@@ -0,0 +1,199 @@
+from typing import Any, Dict, List, Optional
+
+import requests
+
+MESSAGE_ENDPOINT = "/v3"
+
+
+class DefiniteMessageClient:
+    """
+    A message client for sending messages via various channels through the Definite API.
+
+    Initialization:
+    >>> client = DefiniteClient("MY_API_KEY")
+    >>> message_client = client.get_message_client()
+
+    Sending messages:
+    >>> # Send a Slack message
+    >>> result = message_client.send_message(
+    ...     channel="slack",
+    ...     integration_id="slack_integration_id",
+    ...     to="C0920MVPWFN",  # channel_id
+    ...     content="Hello from Definite SDK!"
+    ... )
+    
+    >>> # Send a Slack message with blocks and thread
+    >>> result = message_client.send_message(
+    ...     channel="slack",
+    ...     integration_id="slack_integration_id",
+    ...     to="C0920MVPWFN",
+    ...     content="Hello!",
+    ...     blocks=[{"type": "section", "text": {"type": "mrkdwn", "text": "Hello!"}}],
+    ...     thread_ts="1234567890.123456"
+    ... )
+    """
+
+    def __init__(self, api_key: str, api_url: str):
+        """
+        Initializes the DefiniteMessageClient.
+
+        Args:
+            api_key (str): The API key for authorization.
+            api_url (str): The base URL for the Definite API.
+        """
+        self._api_key = api_key
+        self._message_url = api_url + MESSAGE_ENDPOINT
+
+    def send_message(
+        self,
+        channel: str,
+        integration_id: str,
+        to: str,
+        content: str,
+        subject: Optional[str] = None,
+        blocks: Optional[List[Dict[str, Any]]] = None,
+        thread_ts: Optional[str] = None,
+        **kwargs: Any
+    ) -> Dict[str, Any]:
+        """
+        Sends a message through the specified channel.
+
+        Args:
+            channel (str): The messaging channel to use (e.g., "slack", "email").
+            integration_id (str): The ID of the integration to use.
+            to (str): The recipient identifier (channel_id for Slack, email address for email).
+            content (str): The message content (text for Slack, body for email).
+            subject (Optional[str]): Subject line (used for email).
+            blocks (Optional[List[Dict[str, Any]]]): Slack Block Kit blocks for formatting.
+            thread_ts (Optional[str]): Slack thread timestamp to reply to.
+            **kwargs: Additional channel-specific parameters.
+
+        Returns:
+            Dict[str, Any]: The response from the API.
+
+        Raises:
+            requests.HTTPError: If the API request fails.
+            ValueError: If the channel is not supported.
+
+        Example:
+            >>> # Slack message
+            >>> result = message_client.send_message(
+            ...     channel="slack",
+            ...     integration_id="slack_123",
+            ...     to="C0920MVPWFN",
+            ...     content="Hello team!"
+            ... )
+            
+            >>> # Slack message with blocks
+            >>> result = message_client.send_message(
+            ...     channel="slack",
+            ...     integration_id="slack_123",
+            ...     to="C0920MVPWFN",
+            ...     content="Fallback text",
+            ...     blocks=[{
+            ...         "type": "section",
+            ...         "text": {"type": "mrkdwn", "text": "*Important Update*"}
+            ...     }]
+            ... )
+        """
+        channel_lower = channel.lower()
+        
+        if channel_lower == "slack":
+            return self._send_slack_message(
+                integration_id=integration_id,
+                channel_id=to,
+                text=content,
+                blocks=blocks,
+                thread_ts=thread_ts,
+                **kwargs
+            )
+        else:
+            raise ValueError(f"Unsupported channel: {channel}")
+
+    def _send_slack_message(
+        self,
+        integration_id: str,
+        channel_id: str,
+        text: str,
+        blocks: Optional[List[Dict[str, Any]]] = None,
+        thread_ts: Optional[str] = None,
+        **kwargs: Any
+    ) -> Dict[str, Any]:
+        """
+        Internal method to send a Slack message.
+
+        Args:
+            integration_id (str): The Slack integration ID.
+            channel_id (str): The Slack channel ID.
+            text (str): The message text.
+            blocks (Optional[List[Dict[str, Any]]]): Slack blocks for formatting.
+            thread_ts (Optional[str]): Thread timestamp for replies.
+            **kwargs: Additional Slack-specific parameters.
+
+        Returns:
+            Dict[str, Any]: The API response.
+        """
+        url = f"{self._message_url}/slack/message"
+        
+        payload = {
+            "integration_id": integration_id,
+            "channel_id": channel_id,
+            "text": text
+        }
+        
+        if blocks:
+            payload["blocks"] = blocks
+        if thread_ts:
+            payload["thread_ts"] = thread_ts
+            
+        # Add any additional kwargs to the payload
+        payload.update(kwargs)
+
+        response = requests.post(
+            url,
+            json=payload,
+            headers={"Authorization": "Bearer " + self._api_key},
+        )
+        response.raise_for_status()
+        return response.json()
+
+    def send_slack_message(
+        self,
+        integration_id: str,
+        channel_id: str,
+        text: str,
+        blocks: Optional[List[Dict[str, Any]]] = None,
+        thread_ts: Optional[str] = None,
+        **kwargs: Any
+    ) -> Dict[str, Any]:
+        """
+        Convenience method to send a Slack message directly.
+
+        Args:
+            integration_id (str): The Slack integration ID.
+            channel_id (str): The Slack channel ID.
+            text (str): The message text.
+            blocks (Optional[List[Dict[str, Any]]]): Slack blocks for formatting.
+            thread_ts (Optional[str]): Thread timestamp for replies.
+            **kwargs: Additional Slack-specific parameters.
+
+        Returns:
+            Dict[str, Any]: The API response.
+
+        Example:
+            >>> result = message_client.send_slack_message(
+            ...     integration_id="slack_123",
+            ...     channel_id="C0920MVPWFN",
+            ...     text="Hello from Definite SDK! 👋"
+            ... )
+            >>> print(f"Message sent! Timestamp: {result['ts']}")
+        """
+        return self.send_message(
+            channel="slack",
+            integration_id=integration_id,
+            to=channel_id,
+            content=text,
+            blocks=blocks,
+            thread_ts=thread_ts,
+            **kwargs
+        )

{definite_sdk-0.1.8 → definite_sdk-0.1.11}/definite_sdk/sql.py

@@ -84,7 +84,9 @@ class DefiniteSqlClient:
     def execute_cube_query(
         self, 
         cube_query: Dict[str, Any], 
-        integration_id: Optional[str] = None
+        integration_id: Optional[str] = None,
+        persist: bool = True,
+        invalidate: bool = False,
     ) -> Dict[str, Any]:
         """
         Executes a Cube query against a Cube integration.
@@ -93,6 +95,8 @@ class DefiniteSqlClient:
             cube_query (Dict[str, Any]): The Cube query in JSON format.
             integration_id (Optional[str]): The Cube integration ID to query against.
                 If not provided, the default integration will be used.
+            persist (bool): Whether to persist the query result to the cache.
+            invalidate (bool): Whether to invalidate the cached result.
 
         Returns:
             Dict[str, Any]: The query result as returned by the API.
@@ -116,7 +120,10 @@ class DefiniteSqlClient:
         payload = {"cube_query": cube_query}
         if integration_id:
             payload["integration_id"] = integration_id
-
+        if persist:
+            payload["persist"] = persist
+        if invalidate:
+            payload["invalidate"] = invalidate
         response = requests.post(
             self._sql_url,
             json=payload,

{definite_sdk-0.1.8 → definite_sdk-0.1.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "definite-sdk"
-version = "0.1.8"
+version = "0.1.11"
 description = "Definite SDK for Python"
 authors = ["Definite <hello@definite.app>"]
 license = "MIT"