chore:Housekeeping

Author: iamNarcisse

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Deploy JigsawStack Package to PyPI when a Release is Created
+
+on:
+  release:
+    types: [created]
+jobs:
+  pypi-publish:
+    name: Publish release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/jigsawstack
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel
+      - name: Build package
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -0,0 +1,8 @@
+venv/
+.venv/
+.pytest_cache/
+jigsawstack.egg-info/
+
+.env
+build/  
+dist/ 

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/__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/_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/_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/audio/__init__.py

@@ -0,0 +1,2 @@
+from .audio import Audio
+__all__ = ["Audio"]

jigsawstack/audio/_audio.py

@@ -0,0 +1,18 @@
+
+from typing import Any, Dict, List, cast
+from typing_extensions import NotRequired, TypedDict
+
+
+
+class SpeechToTextParams(TypedDict):
+    url:str
+    file_store_key : NotRequired[str]
+    language : NotRequired[str]
+    translate : NotRequired[bool]
+    by_speaker : NotRequired[bool]
+    webhook_url : NotRequired[str]
+
+class SpeechToTextResponse(TypedDict):
+    success:bool
+    text : str
+    chunks : List[object]

jigsawstack/audio/audio.py

@@ -0,0 +1,15 @@
+from typing import Any, Dict, List, cast
+from typing_extensions import NotRequired, TypedDict
+from jigsawstack import request
+from ._audio import SpeechToTextParams, SpeechToTextResponse
+from .._config import ClientConfig
+class Audio(ClientConfig):
+
+    def speech_to_text(self, params: SpeechToTextParams) -> SpeechToTextResponse:
+        path = "/ai/transcribe"
+        resp = request.Request(
+            api_key=self.api_key,
+            api_url=self.api_url,
+            path=path, params=cast(Dict[Any, Any], params), verb="post"
+        ).perform_with_content()
+        return resp