jigsawstack 0.1__tar.gz

jigsawstack-0.1/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: jigsawstack
+Version: 0.1
+Summary: JigsawStack Python SDK
+Home-page: https://github.com/jigsawstack/jigsawstack-py
+Author: Narcisse
+Author-email: hello@jigsawstack.com
+Keywords: AI,AI Tooling
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.31.0
+Requires-Dist: typing_extensions
+
+# JigsawStack Python SDK
+
+## Installation
+
+To install JigsawStack Python SDK, simply execute the following command in a terminal:
+
+```
+pip install jigsawstack
+```
+
+## Setup
+
+First, you need to get an API key, which is available in the [JigsawStack Dashboard](https://jigsawstack.com).
+
+```py
+from jigsawstack from JigsawStack
+
+import os
+
+ ai = JigsawStack(api_key="your-api-key")
+```
+
+## Example
+
+```py
+import os
+from jigsawstack from JigsawStack
+
+
+ai = JigsawStack(api_key="your-api-key")
+
+params = {
+    "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z"
+}
+
+result = ai.vision.vocr(params)
+
+print(result)
+```

jigsawstack-0.1/README.md

@@ -0,0 +1,39 @@
+# JigsawStack Python SDK
+
+## Installation
+
+To install JigsawStack Python SDK, simply execute the following command in a terminal:
+
+```
+pip install jigsawstack
+```
+
+## Setup
+
+First, you need to get an API key, which is available in the [JigsawStack Dashboard](https://jigsawstack.com).
+
+```py
+from jigsawstack from JigsawStack
+
+import os
+
+ ai = JigsawStack(api_key="your-api-key")
+```
+
+## Example
+
+```py
+import os
+from jigsawstack from JigsawStack
+
+
+ai = JigsawStack(api_key="your-api-key")
+
+params = {
+    "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z"
+}
+
+result = ai.vision.vocr(params)
+
+print(result)
+```

jigsawstack-0.1/jigsawstack/__init__.py

@@ -0,0 +1,10 @@
+import os
+from ._client import JigsawStack
+
+# Config vars
+api_key = os.environ.get("JIGSAWSTACK_API_KEY", "")
+api_url = os.environ.get("JIGSAWSTACK_API_URL", "https://api.jigsawstack.com")
+
+
+# Create a global instance of the Web class
+__all__ = ["JigsawStack"]

jigsawstack-0.1/jigsawstack/_client.py

@@ -0,0 +1,52 @@
+
+from . import resources
+from typing import Union
+from ._config import ClientConfig
+import os
+
+
+class JigsawStack:
+    audio: resources.Audio
+    vision : resources.Vision
+    prediction: resources.Prediction
+    sql: resources.SQL
+    file: resources.File
+    kv: resources.KV
+    translate: resources.Translate
+    web: resources.Web
+    sentiment: resources.Sentiment
+    validate: resources.Validate
+    summary: resources.Summary
+    search: resources.Search
+    api_key: str
+    api_url: str
+
+
+    def __init__(self, api_key: Union[str, None] = None, api_url: Union[str, None] = None) -> None:
+        if api_key is None:
+            api_key = os.environ.get("JIGSAWSTACK_API_KEY")
+        
+        if api_key is None:
+            raise ValueError("The api_key client option must be set either by passing api_key to the client or by setting the JIGSAWSTACK_API_KEY environment variable")
+        
+        if api_url is None:
+            api_url = os.environ.get("JIGSAWSTACK_API_URL")
+        if api_url is None:
+            api_url = f"https://api.jigsawstack.com/v1"
+
+        self.api_key = api_key
+        self.api_url = api_url
+
+
+        self.audio = resources.Audio(api_key=api_key, api_url=api_url)
+        self.web = resources.Web(api_key=api_key, api_url=api_url)
+        self.search = resources.Search(api_key=api_key, api_url=api_url)
+        self.sentiment = resources.Sentiment(api_key=api_key, api_url=api_url)
+        self.validate = resources.Validate(api_key=api_key, api_url=api_url)
+        self.summary = resources.Summary(api_key=api_key, api_url=api_url)
+        self.vision = resources.Vision(api_key=api_key, api_url=api_url)
+        self.prediction = resources.Prediction(api_key=api_key, api_url=api_url)
+        self.sql = resources.SQL(api_key=api_key, api_url=api_url)
+        self.file = resources.File(api_key=api_key, api_url=api_url)
+        self.kv = resources.KV(api_key=api_key, api_url=api_url)
+        self.translate = resources.Translate(api_key=api_key, api_url=api_url)

jigsawstack-0.1/jigsawstack/_config.py

@@ -0,0 +1,8 @@
+class ClientConfig:
+
+    base_url:str
+    api_key:str
+    
+    def __init__(self, api_key: str, api_url: str):
+        self.api_key = api_key
+        self.api_url = api_url

jigsawstack-0.1/jigsawstack/exceptions.py

@@ -0,0 +1,228 @@
+"""JigsawStack Exceptions module.
+
+This module defines the base types for platform-wide error
+
+"""
+
+from typing import Any, Dict, Union
+
+
+class JigsawStackError(Exception):
+    """Base class for all errors raised by JigsawStack SDK.
+    This is the parent class of all exceptions (server side)
+    raised by the JigsawStack SDK. Developers can simply catch
+    this class and inspect its `code` to implement more specific
+    error handling. Note that for some client-side errors ie:
+    some method argument missing, a ValueError would be raised.
+
+    Args:
+        code: A string error indicating the HTTP status code
+        attributed to that Error.
+        message: A human-readable error message string.
+        suggested_action: A suggested action path to help the user.
+        error_type: Maps to the `type` field from the JigsawStack API
+    """
+
+    def __init__(
+        self,
+        code: Union[str, int],
+        error_type: str,
+        message: str,
+        suggested_action: str,
+    ):
+        Exception.__init__(self, message)
+        self.code = code
+        self.message = message
+        self.suggested_action = suggested_action
+        self.error_type = error_type
+
+
+class MissingApiKeyError(JigsawStackError):
+
+    def __init__(
+        self,
+        message: str,
+        error_type: str,
+        code: Union[str, int],
+    ):
+        suggested_action = """Include the following header
+        Authorization: Bearer YOUR_API_KEY in the request."""
+
+        message = "Missing API key in the authorization header."
+
+        JigsawStackError.__init__(
+            self,
+            message=message,
+            suggested_action=suggested_action,
+            code=code,
+            error_type=error_type,
+        )
+
+
+class InvalidApiKeyError(JigsawStackError):
+   
+
+    def __init__(
+        self,
+        message: str,
+        error_type: str,
+        code: Union[str, int],
+    ):
+        suggested_action = """Generate a new API key in the dashboard."""
+
+        JigsawStackError.__init__(
+            self,
+            message=message,
+            suggested_action=suggested_action,
+            code=code,
+            error_type=error_type,
+        )
+
+
+class ValidationError(JigsawStackError):
+
+
+    def __init__(
+        self,
+        message: str,
+        error_type: str,
+        code: Union[str, int],
+    ):
+        default_message = """
+        The request body is missing one or more required fields."""
+
+        suggested_action = """Check the error message
+        to see the list of missing fields."""
+
+        if message == "":
+            message = default_message
+
+        JigsawStackError.__init__(
+            self,
+            code=code or "400",
+            message=message,
+            suggested_action=suggested_action,
+            error_type=error_type,
+        )
+
+
+class MissingRequiredFieldsError(JigsawStackError):
+
+    def __init__(
+        self,
+        message: str,
+        error_type: str,
+        code: Union[str, int],
+    ):
+        default_message = """
+        The request body is missing one or more required fields."""
+
+        suggested_action = """Check the error message
+        to see the list of missing fields."""
+
+        if message == "":
+            message = default_message
+
+        JigsawStackError.__init__(
+            self,
+            code=code or "422",
+            message=message,
+            suggested_action=suggested_action,
+            error_type=error_type,
+        )
+
+
+class ApplicationError(JigsawStackError):
+
+
+    def __init__(
+        self,
+        message: str,
+        error_type: str,
+        code: Union[str, int],
+    ):
+        default_message = """
+        Something went wrong."""
+
+        suggested_action = """Contact JigsawStack support."""
+
+        if message == "":
+            message = default_message
+
+        JigsawStackError.__init__(
+            self,
+            code=code or "500",
+            message=message,
+            suggested_action=suggested_action,
+            error_type=error_type,
+        )
+
+
+# Dict with error code -> error type mapping
+ERRORS: Dict[str, Dict[str, Any]] = {
+    "400": {"validation_error": ValidationError},
+    "422": {
+        "missing_required_fields": MissingRequiredFieldsError,
+        "validation_error": ValidationError,
+    },
+    "401": {"missing_api_key": MissingApiKeyError},
+    "403": {"invalid_api_key": InvalidApiKeyError},
+    "500": {"application_error": ApplicationError},
+}
+
+
+def raise_for_code_and_type(
+    code: Union[str, int], error_type: str, message: str
+) -> None:
+    """Raise the appropriate error based on the code and type.
+
+    Args:
+        code (str): The error code
+        error_type (str): The error type
+        message (str): The error message
+
+    Raises:
+        JigsawStackError: If it is a JigsawStack err
+            or
+        ValidationError: If the error type is validation_error
+            or
+        MissingRequiredFieldsError: If the error type is missing_required_fields
+            or
+        MissingApiKeyError: If the error type is missing_api_key
+            or
+        InvalidApiKeyError: If the error type is invalid_api_key
+            or
+        ApplicationError: If the error type is application_error
+            or
+        TypeError: If the error type is not found
+    """
+    error = ERRORS.get(str(code))
+
+    # Handle the case where the error might be unknown
+    if error is None:
+        raise JigsawStackError(
+            code=code, message=message, error_type=error_type, suggested_action=""
+        )
+
+    # Raise error from errors list
+    error_from_list = error.get(error_type)
+
+    if error_from_list is not None:
+        raise error_from_list(
+            code=code,
+            message=message,
+            error_type=error_type,
+        )
+    # defaults to JigsawStackError if finally can't find error type
+    raise JigsawStackError(
+        code=code, message=message, error_type=error_type, suggested_action=""
+    )
+
+
+class NoContentError(Exception):
+    """Raised when the response body is empty."""
+
+    def __init__(self) -> None:
+        self.message = """No content was returned from the API.
+            Please contact Jigsawstack support."""
+        Exception.__init__(self, self.message)

jigsawstack-0.1/jigsawstack/request.py

@@ -0,0 +1,116 @@
+from typing import Any, Dict, Generic, List, Union, cast
+
+import requests
+from typing_extensions import Literal, TypeVar
+
+import jigsawstack
+from jigsawstack.exceptions import NoContentError, raise_for_code_and_type
+
+RequestVerb = Literal["get", "post", "put", "patch", "delete"]
+
+T = TypeVar("T")
+
+
+# This class wraps the HTTP request creation logic
+class Request(Generic[T]):
+    def __init__(
+        self,
+        api_url:str,
+        api_key:str,
+        path: str,
+        params: Union[Dict[Any, Any], List[Dict[Any, Any]]],
+        verb: RequestVerb
+    ):
+        self.path = path
+        self.params = params
+        self.verb = verb
+        self.api_url = api_url
+        self.api_key = api_key
+
+    def perform(self) -> Union[T, None]:
+        """Is the main function that makes the HTTP request
+        to the JigsawStack API. It uses the path, params, and verb attributes
+        to make the request.
+
+        Returns:
+            Union[T, None]: A generic type of the Request class or None
+
+        Raises:
+            requests.HTTPError: If the request fails
+        """
+        resp = self.make_request(url=f"{self.api_url}{self.path}")
+
+        # delete calls do not return a body
+        if resp.text == "" and resp.status_code == 200:
+            return None
+
+        # this is a safety net, if we get here it means the JigsawStack API is having issues
+        # and most likely the gateway is returning htmls
+        if "application/json" not in resp.headers["content-type"]:
+            raise_for_code_and_type(
+                code=500,
+                message="Failed to parse JigsawStack API response. Please try again.",
+                error_type="InternalServerError",
+            )
+
+        # handle error in case there is a statusCode attr present
+        # and status != 200 and response is a json.
+        if resp.status_code != 200 and resp.json().get("statusCode"):
+            error = resp.json()
+            raise_for_code_and_type(
+                code=error.get("statusCode"),
+                message=error.get("message"),
+                error_type=error.get("name"),
+            )
+        return cast(T, resp.json())
+
+    def perform_with_content(self) -> T:
+        """
+        Perform an HTTP request and return the response content.
+
+        Returns:
+            T: The content of the response
+
+        Raises:
+            NoContentError: If the response content is `None`.
+        """
+        resp = self.perform()
+        if resp is None:
+            raise NoContentError()
+        return resp
+
+    def __get_headers(self) -> Dict[Any, Any]:
+        """get_headers returns the HTTP headers that will be
+        used for every req.
+
+        Returns:
+            Dict: configured HTTP Headers
+        """
+        return {
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "x-api-key": f"{self.api_key}"
+        }
+
+    def make_request(self, url: str) -> requests.Response:
+        """make_request is a helper function that makes the actual
+        HTTP request to the JigsawStack API.
+
+        Args:
+            url (str): The URL to make the request to
+
+        Returns:
+            requests.Response: The response object from the request
+
+        Raises:
+            requests.HTTPError: If the request fails
+        """
+        headers = self.__get_headers()
+        params = self.params
+        verb = self.verb
+
+        print("ABOUT TO MAKE REQUEST WITH HEADERS",headers)
+        try:
+            return requests.request(verb, url, json=params, headers=headers,)
+        except requests.HTTPError as e:
+            raise e

jigsawstack-0.1/jigsawstack.egg-info/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: jigsawstack
+Version: 0.1
+Summary: JigsawStack Python SDK
+Home-page: https://github.com/jigsawstack/jigsawstack-py
+Author: Narcisse
+Author-email: hello@jigsawstack.com
+Keywords: AI,AI Tooling
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.31.0
+Requires-Dist: typing_extensions
+
+# JigsawStack Python SDK
+
+## Installation
+
+To install JigsawStack Python SDK, simply execute the following command in a terminal:
+
+```
+pip install jigsawstack
+```
+
+## Setup
+
+First, you need to get an API key, which is available in the [JigsawStack Dashboard](https://jigsawstack.com).
+
+```py
+from jigsawstack from JigsawStack
+
+import os
+
+ ai = JigsawStack(api_key="your-api-key")
+```
+
+## Example
+
+```py
+import os
+from jigsawstack from JigsawStack
+
+
+ai = JigsawStack(api_key="your-api-key")
+
+params = {
+    "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z"
+}
+
+result = ai.vision.vocr(params)
+
+print(result)
+```

jigsawstack-0.1/jigsawstack.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+setup.py
+jigsawstack/__init__.py
+jigsawstack/_client.py
+jigsawstack/_config.py
+jigsawstack/exceptions.py
+jigsawstack/request.py
+jigsawstack.egg-info/PKG-INFO
+jigsawstack.egg-info/SOURCES.txt
+jigsawstack.egg-info/dependency_links.txt
+jigsawstack.egg-info/not-zip-safe
+jigsawstack.egg-info/requires.txt
+jigsawstack.egg-info/top_level.txt
+tests/test_search.py
+tests/test_sentiment.py
+tests/test_web.py

jigsawstack-0.1/jigsawstack.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

jigsawstack-0.1/jigsawstack.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

jigsawstack-0.1/jigsawstack.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests>=2.31.0
+typing_extensions

jigsawstack-0.1/jigsawstack.egg-info/top_level.txt

@@ -0,0 +1 @@
+jigsawstack

jigsawstack-0.1/setup.cfg

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

jigsawstack-0.1/setup.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+
+from setuptools import find_packages, setup
+
+
+install_requires = open("requirements.txt").readlines()
+
+setup(
+    name="jigsawstack",
+    version="0.1",
+    description="JigsawStack Python SDK",
+    long_description=open("README.md", encoding="utf8").read(),
+    long_description_content_type="text/markdown",
+    author="Narcisse",
+    author_email="hello@jigsawstack.com",
+    url="https://github.com/jigsawstack/jigsawstack-py",
+    packages=find_packages(include=["jigsawstack"]),
+    install_requires=install_requires,
+    zip_safe=False,
+    python_requires=">=3.7",
+    keywords=["AI", "AI Tooling"],
+    setup_requires=['pytest-runner'],
+    tests_require=['pytest'],
+    test_suite='tests',
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+    ],
+)

jigsawstack-0.1/tests/test_search.py

@@ -0,0 +1,32 @@
+from unittest.mock import MagicMock
+import unittest
+from jigsawstack.exceptions import JigsawStackError
+import jigsawstack
+import pytest
+# flake8: noq
+
+jigsaw = jigsawstack.JigsawStack()
+
+
+
+class TestSearchAPI(unittest.TestCase):
+
+    def test_search_suggestion_response_success(self) -> None:
+        params = {
+            "query": "Time Square New Yor"
+        }
+        try:
+            result = jigsaw.search.suggestion(params)
+            assert result["success"] == True
+        except JigsawStackError as e:
+            assert e.message == "Failed to parse API response. Please try again."
+
+    def test_ai_search_response_success(self) -> None:
+        params = {
+            "query": "Time Square New Yor"
+        }
+        try:
+            result = jigsaw.search.ai_search(params)
+            assert result["success"] == True
+        except JigsawStackError as e:
+            assert e.message == "Failed to parse API response. Please try again."

jigsawstack-0.1/tests/test_sentiment.py

@@ -0,0 +1,21 @@
+from unittest.mock import MagicMock
+import unittest
+from jigsawstack.exceptions import JigsawStackError
+import jigsawstack
+
+import pytest
+# flake8: noqa
+
+client = jigsawstack.JigsawStack()
+
+@pytest.mark.skip(reason="Skipping TestWebAPI class for now")
+class TestSentimentAPI(unittest.TestCase):
+    def test_sentiment_response_success(self) -> None:
+        params = {
+            "text": "I am so excited"
+        }
+        try:
+            result = client.sentiment.analyze(params)
+            assert result["success"] == True
+        except JigsawStackError as e:
+            assert e.message == "Failed to parse API response. Please try again."

jigsawstack-0.1/tests/test_web.py

@@ -0,0 +1,49 @@
+from unittest.mock import MagicMock
+import unittest
+
+from jigsawstack.exceptions import JigsawStackError
+
+import jigsawstack
+import jigsawstack.sentiment
+import jigsawstack.sentiment._sentiment
+import jigsawstack.translate
+import jigsawstack.translate._translate
+import jigsawstack.web
+import jigsawstack
+import pytest
+# flake8: noqa
+
+
+@pytest.mark.skip(reason="Skipping TestWebAPI class for now")
+class TestWebAPI(unittest.TestCase):
+    def test_ai_scrape_success_response(self) -> None:
+        params = {
+         "url": "https://supabase.com/pricing",
+         "element_prompts": ["Plan title", "Plan price"],
+        }
+        try:
+            result = jigsawstack.Web.ai_scrape(params)
+            assert result["success"] == True
+        except JigsawStackError as e:
+            assert e.message == "Failed to parse API response. Please try again."
+
+    def test_scrape_success_response(self) -> None:
+        params = {
+         "url": "https://supabase.com/pricing",
+        }
+        try:
+            result = jigsawstack.Web.scrape(params)
+            assert result["success"] == True
+        except JigsawStackError as e:
+            assert e.message == "Failed to parse API response. Please try again."
+
+    def test_dns_success_response(self) -> None:
+
+        params = {
+                "url": "https://supabase.com/pricing",
+        }
+        try:
+            result = jigsawstack.Web.dns(params)
+            assert result["success"] == True
+        except JigsawStackError as e:
+            assert e.message == "Failed to parse API response. Please try again."