# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/jigsawstack/jigsawstack-python",
"name": "jigsawstack",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "AI, AI Tooling",
"author": "Narcisse Egonu",
"author_email": "hello@jigsawstack.com",
"download_url": "https://files.pythonhosted.org/packages/f0/0f/894a3b75cb54c08b6569593eaa8297b44b8448c2e83990b5e974ed9819b7/jigsawstack-0.1.19.tar.gz",
"platform": null,
"description": "# JigsawStack Python SDK\n\nThe JigsawStack Python SDK allows you to interact with powerful AI services to build AI-powered applications.\n\n- \ud83e\udde9 Powerful AI services all in one SDK\n- \u2328\ufe0f Fully typed parameters and responses\n- \ud83d\udce1 Built in Webhook support for long-running tasks\n- \ud83d\udce6 Built in file system for easy file uploads\n\n## Learn more\n\nTo learn more about all available JigsawStack AI services, view the [Documentation](https://docs.jigsawstack.com) or [Website](https://jigsawstack.com).\n\n## All APIs\n\n| Category | APIs |\n| ----------------- | ------------------------------------------------- |\n| **\ud83d\udc49 General** | Translation, Summarization, Sentiment Analysis |\n| **\ud83c\udf10 Web** | AI Web Scraping, AI Web Search |\n| **\ud83c\udfb5 Audio** | Text to Speech, Speech to Text (Whisper large v3) |\n| **\ud83d\udc40 Vision** | vOCR, Object Detection |\n| **\ud83e\udde0 LLMs** | Prompt Engine |\n| **\ud83d\uddbc\ufe0f Generative** | AI Image (SD, SDXL-Fast & more), HTML to Any |\n| **\ud83c\udf0d Geo** | Location search, Timezone, IP Geolocation & more |\n| **\u2705 Validation** | Email, NSFW images, profanity & more |\n| **\ud83d\udcc1 Store** | Simple File Storage, KV Encryption store |\n\nLearn more of about each category in the [API reference](https://docs.jigsawstack.com/api-reference)\n\n## Installation\n\nTo install JigsawStack Python SDK, simply execute the following command in a terminal:\n\n```\npip install jigsawstack\n```\n\n## Setup\n\nFirst, get your API key from the [JigsawStack Dashboard](https://jigsawstack.com/dashboard)\n\nThen, initialize the SDK:\n\n```py\nfrom jigsawstack import JigsawStack\n\njigsaw = JigsawStack(api_key=\"your-api-key\")\n```\n\n## Usage\n\nAI Scraping Example:\n\n```py\nparams = {\n \"url\": \"https://www.amazon.com/Cadbury-Mini-Caramel-Eggs-Bulk/dp/B0CWM99G5W\",\n \"element_prompts\": [\"prices\"]\n}\nresult = jigsaw.web.ai_scrape(params)\n```\n\nText To Speech Example:\n\n```py\nparams = {\"text\": \"Hello, how are you doing?\"}\nresult = jigsaw.audio.text_to_speech(params)\n```\n\nSpeech To Text Example:\n\n```py\nparams = { \"url\": \"https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Video%201737458382653833217.mp4?t=2024-03-22T09%3A50%3A49.894Z\"}\nresult = jigsaw.audio.speech_to_text(params)\n```\n\nVOCR:\n\n```py\nparams = {\n \"url\": \"https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z\"\n}\nresult = jigsaw.vision.vocr(params)\n```\n\n## Community\n\nJoin JigsawStack community on [Discord](https://discord.gg/dj8fMBpnqd) to connect with other developers, share ideas, and get help with the SDK.\n\n## Related Projects\n\n- [Docs](https://docs.jigsawstack.com)\n- [Javascript SDK](https://github.com/JigsawStack/jigsawstack-js)\n\n## Contributing\n\nJigsawStack 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.\n",
"bugtrack_url": null,
"license": null,
"summary": "JigsawStack Python SDK",
"version": "0.1.19",
"project_urls": {
"Homepage": "https://github.com/jigsawstack/jigsawstack-python"
},
"split_keywords": [
"ai",
" ai tooling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86b36f929eac810711dc4170523482aad5e16aea95f1004adcbedca6592e58ad",
"md5": "3ef946db3b15f0764b8368e452528e61",
"sha256": "2e74b48670b4f6d30e5182d00226d1a58a42141cae154d6801ed42e9864f0df5"
},
"downloads": -1,
"filename": "jigsawstack-0.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ef946db3b15f0764b8368e452528e61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20576,
"upload_time": "2024-11-07T17:02:00",
"upload_time_iso_8601": "2024-11-07T17:02:00.937257Z",
"url": "https://files.pythonhosted.org/packages/86/b3/6f929eac810711dc4170523482aad5e16aea95f1004adcbedca6592e58ad/jigsawstack-0.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f00f894a3b75cb54c08b6569593eaa8297b44b8448c2e83990b5e974ed9819b7",
"md5": "983a9c1cd85b780906cd3e9ffa467166",
"sha256": "4fa60e3c51dbc84850f18b9c90a396e0019f7b9c242643b730271ddf8e3498af"
},
"downloads": -1,
"filename": "jigsawstack-0.1.19.tar.gz",
"has_sig": false,
"md5_digest": "983a9c1cd85b780906cd3e9ffa467166",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14805,
"upload_time": "2024-11-07T17:02:03",
"upload_time_iso_8601": "2024-11-07T17:02:03.329416Z",
"url": "https://files.pythonhosted.org/packages/f0/0f/894a3b75cb54c08b6569593eaa8297b44b8448c2e83990b5e974ed9819b7/jigsawstack-0.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 17:02:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jigsawstack",
"github_project": "jigsawstack-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "jigsawstack"
}
JSON
