jigsawstack 0.1.26__tar.gz

jigsawstack-0.1.26/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.2
+Name: jigsawstack
+Version: 0.1.26
+Summary: JigsawStack Python SDK
+Home-page: https://github.com/jigsawstack/jigsawstack-python
+Author: Narcisse Egonu
+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
+Requires-Dist: aiohttp
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# JigsawStack Python SDK
+
+The JigsawStack Python SDK allows you to interact with powerful AI services to build AI-powered applications.
+
+- 🧩 Powerful AI services all in one SDK
+- ⌨️ Fully typed parameters and responses
+- 📡 Built in Webhook support for long-running tasks
+- 📦 Built in file system for easy file uploads
+
+## Learn more
+
+To learn more about all available JigsawStack AI services, view the [Documentation](https://docs.jigsawstack.com) or [Website](https://jigsawstack.com).
+
+## All APIs
+
+| Category          | APIs                                              |
+| ----------------- | ------------------------------------------------- |
+| **👉 General**    | Translation, Summarization, Sentiment Analysis    |
+| **🌐 Web**        | AI Web Scraping, AI Web Search                    |
+| **🎵 Audio**      | Text to Speech, Speech to Text (Whisper large v3) |
+| **👀 Vision**     | vOCR, Object Detection                            |
+| **🧠 LLMs**       | Prompt Engine                                     |
+| **🖼️ Generative** | AI Image (SD, SDXL-Fast & more), HTML to Any      |
+| **🌍 Geo**        | Location search, Timezone, IP Geolocation & more  |
+| **✅ Validation** | Email, NSFW images, profanity & more              |
+| **📁 Store**      | Simple File Storage, KV Encryption store          |
+
+Learn more of about each category in the [API reference](https://docs.jigsawstack.com/api-reference)
+
+## Installation
+
+To install JigsawStack Python SDK, simply execute the following command in a terminal:
+
+```
+pip install jigsawstack
+```
+
+## Setup
+
+First, get your API key from the [JigsawStack Dashboard](https://jigsawstack.com/dashboard)
+
+Then, initialize the SDK:
+
+```py
+from jigsawstack import JigsawStack
+
+jigsaw = JigsawStack(api_key="your-api-key")
+```
+
+## Usage
+
+AI Scraping Example:
+
+```py
+params = {
+ "url": "https://www.amazon.com/Cadbury-Mini-Caramel-Eggs-Bulk/dp/B0CWM99G5W",
+ "element_prompts": ["prices"]
+}
+result = jigsaw.web.ai_scrape(params)
+```
+
+Text To Speech Example:
+
+```py
+params = {"text": "Hello, how are you doing?"}
+result = jigsaw.audio.text_to_speech(params)
+```
+
+Speech To Text Example:
+
+```py
+params = { "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Video%201737458382653833217.mp4?t=2024-03-22T09%3A50%3A49.894Z"}
+result = jigsaw.audio.speech_to_text(params)
+```
+
+VOCR:
+
+```py
+params = {
+    "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z"
+}
+result = jigsaw.vision.vocr(params)
+```
+
+## Community
+
+Join JigsawStack community on [Discord](https://discord.gg/dj8fMBpnqd) to connect with other developers, share ideas, and get help with the SDK.
+
+## Related Projects
+
+- [Docs](https://docs.jigsawstack.com)
+- [Javascript SDK](https://github.com/JigsawStack/jigsawstack-js)
+
+## Contributing
+
+JigsawStack AI SDK is open-source and welcomes contributions. Please open an issue or submit a pull request with your changes. Make sure to be as descriptive as possible with your submissions, include examples if relevant.

jigsawstack-0.1.26/README.md

@@ -0,0 +1,96 @@
+# JigsawStack Python SDK
+
+The JigsawStack Python SDK allows you to interact with powerful AI services to build AI-powered applications.
+
+- 🧩 Powerful AI services all in one SDK
+- ⌨️ Fully typed parameters and responses
+- 📡 Built in Webhook support for long-running tasks
+- 📦 Built in file system for easy file uploads
+
+## Learn more
+
+To learn more about all available JigsawStack AI services, view the [Documentation](https://docs.jigsawstack.com) or [Website](https://jigsawstack.com).
+
+## All APIs
+
+| Category          | APIs                                              |
+| ----------------- | ------------------------------------------------- |
+| **👉 General**    | Translation, Summarization, Sentiment Analysis    |
+| **🌐 Web**        | AI Web Scraping, AI Web Search                    |
+| **🎵 Audio**      | Text to Speech, Speech to Text (Whisper large v3) |
+| **👀 Vision**     | vOCR, Object Detection                            |
+| **🧠 LLMs**       | Prompt Engine                                     |
+| **🖼️ Generative** | AI Image (SD, SDXL-Fast & more), HTML to Any      |
+| **🌍 Geo**        | Location search, Timezone, IP Geolocation & more  |
+| **✅ Validation** | Email, NSFW images, profanity & more              |
+| **📁 Store**      | Simple File Storage, KV Encryption store          |
+
+Learn more of about each category in the [API reference](https://docs.jigsawstack.com/api-reference)
+
+## Installation
+
+To install JigsawStack Python SDK, simply execute the following command in a terminal:
+
+```
+pip install jigsawstack
+```
+
+## Setup
+
+First, get your API key from the [JigsawStack Dashboard](https://jigsawstack.com/dashboard)
+
+Then, initialize the SDK:
+
+```py
+from jigsawstack import JigsawStack
+
+jigsaw = JigsawStack(api_key="your-api-key")
+```
+
+## Usage
+
+AI Scraping Example:
+
+```py
+params = {
+ "url": "https://www.amazon.com/Cadbury-Mini-Caramel-Eggs-Bulk/dp/B0CWM99G5W",
+ "element_prompts": ["prices"]
+}
+result = jigsaw.web.ai_scrape(params)
+```
+
+Text To Speech Example:
+
+```py
+params = {"text": "Hello, how are you doing?"}
+result = jigsaw.audio.text_to_speech(params)
+```
+
+Speech To Text Example:
+
+```py
+params = { "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Video%201737458382653833217.mp4?t=2024-03-22T09%3A50%3A49.894Z"}
+result = jigsaw.audio.speech_to_text(params)
+```
+
+VOCR:
+
+```py
+params = {
+    "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z"
+}
+result = jigsaw.vision.vocr(params)
+```
+
+## Community
+
+Join JigsawStack community on [Discord](https://discord.gg/dj8fMBpnqd) to connect with other developers, share ideas, and get help with the SDK.
+
+## Related Projects
+
+- [Docs](https://docs.jigsawstack.com)
+- [Javascript SDK](https://github.com/JigsawStack/jigsawstack-js)
+
+## Contributing
+
+JigsawStack AI SDK is open-source and welcomes contributions. Please open an issue or submit a pull request with your changes. Make sure to be as descriptive as possible with your submissions, include examples if relevant.

jigsawstack-0.1.26/jigsawstack/__init__.py

@@ -0,0 +1,232 @@
+from typing import Union
+import os
+from .audio import Audio, AsyncAudio
+from .vision import Vision, AsyncVision
+from .search import Search
+from .prediction import Prediction, AsyncPrediction
+from .sql import SQL, AsyncSQL
+from .store import Store, AsyncStore
+from .translate import Translate, AsyncTranslate
+from .web import Web, AsyncWeb
+from .sentiment import Sentiment, AsyncSentiment
+from .validate import Validate, AsyncValidate
+from .summary import Summary, AsyncSummary
+from .geo import Geo, AsyncGeo
+from .prompt_engine import PromptEngine, AsyncPromptEngine
+from .embedding import Embedding, AsyncEmbedding
+from .exceptions import JigsawStackError
+
+
+class JigsawStack:
+    audio: Audio
+    vision: Vision
+    file: Store
+    web: Web
+    search: Search
+    geo: Geo
+    prompt_engine: PromptEngine
+    api_key: str
+    api_url: str
+    disable_request_logging: bool
+
+    def __init__(
+        self,
+        api_key: Union[str, None] = None,
+        api_url: Union[str, None] = None,
+        disable_request_logging: Union[bool, 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 = Audio(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.web = Web(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.sentiment = Sentiment(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).analyze
+        self.validate = Validate(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.summary = Summary(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).summarize
+        self.vision = Vision(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.prediction = Prediction(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).predict
+        self.text_to_sql = SQL(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).text_to_sql
+        self.store = Store(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.translate = Translate(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).translate
+        self.geo = Geo(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.prompt_engine = PromptEngine(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.embedding = Embedding(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).execute
+
+
+class AsyncJigsawStack:
+    geo: AsyncGeo
+    validate: AsyncValidate
+    web: AsyncWeb
+    audio: AsyncAudio
+    vision: AsyncVision
+    store: AsyncStore
+    prompt_engine: AsyncPromptEngine
+    api_key: str
+    api_url: str
+    disable_request_logging: bool
+
+    def __init__(
+        self,
+        api_key: Union[str, None] = None,
+        api_url: Union[str, None] = None,
+        disable_request_logging: Union[bool, 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.web = AsyncWeb(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+
+        self.geo = AsyncGeo(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+
+        self.validate = AsyncValidate(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.audio = AsyncAudio(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+
+        self.vision = AsyncVision(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+
+        self.store = AsyncStore(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+
+        self.summary = AsyncSummary(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).summarize
+
+        self.prediction = AsyncPrediction(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).predict
+        self.text_to_sql = AsyncSQL(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).text_to_sql
+
+        self.sentiment = AsyncSentiment(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).analyze
+
+        self.translate = AsyncTranslate(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).translate
+
+        self.prompt_engine = AsyncPromptEngine(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        )
+        self.embedding = AsyncEmbedding(
+            api_key=api_key,
+            api_url=api_url,
+            disable_request_logging=disable_request_logging,
+        ).execute
+
+
+# Create a global instance of the Web class
+__all__ = ["JigsawStack", "Search", "JigsawStackError", "AsyncJigsawStack"]

jigsawstack-0.1.26/jigsawstack/_client.py

@@ -0,0 +1,62 @@
+from typing import Union
+import os
+from .audio import Audio
+from .vision import Vision
+from .search import Search
+from .prediction import Prediction
+from .sql import SQL
+from .store import KV, File
+from .translate import Translate
+from .web import Web
+from .sentiment import Sentiment
+from .validate import Validate
+from .summary import Summary
+
+
+class JigsawStack:
+    audio: Audio
+    vision: Vision
+    prediction: Prediction
+    sql: SQL
+    file: File
+    kv: KV
+    translate: Translate
+    web: Web
+    sentiment: Sentiment
+    validate: Validate
+    summary: Summary
+    search: 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 = Audio(api_key=api_key, api_url=api_url)
+        self.web = Web(api_key=api_key, api_url=api_url)
+        self.search = Search(api_key=api_key, api_url=api_url)
+        self.sentiment = Sentiment(api_key=api_key, api_url=api_url)
+        self.validate = Validate(api_key=api_key, api_url=api_url)
+        self.summary = Summary(api_key=api_key, api_url=api_url)
+        self.vision = Vision(api_key=api_key, api_url=api_url)
+        self.prediction = Prediction(api_key=api_key, api_url=api_url)
+        self.sql = SQL(api_key=api_key, api_url=api_url)
+        self.file = File(api_key=api_key, api_url=api_url)
+        self.kv = KV(api_key=api_key, api_url=api_url)
+        self.translate = Translate(api_key=api_key, api_url=api_url)

jigsawstack-0.1.26/jigsawstack/_config.py

@@ -0,0 +1,17 @@
+from typing import Union
+
+
+class ClientConfig:
+    base_url: str
+    api_key: str
+    disable_request_logging: Union[bool, None] = None
+
+    def __init__(
+        self,
+        api_key: str,
+        api_url: str,
+        disable_request_logging: Union[bool, None] = None,
+    ):
+        self.api_key = api_key
+        self.api_url = api_url
+        self.disable_request_logging = disable_request_logging