<div align="center">
<img src="docs/assets/unstract_u_logo.png" style="height: 120px">
# Unstract
## No-code LLM Platform to launch APIs and ETL Pipelines to structure unstructured documents
</div>
# Unstract SDK
The `unstract-sdk` package helps with developing tools that are meant to be run on the Unstract platform. This includes
modules to help with tool development and execution, caching, making calls to LLMs / vectorDBs / embeddings .etc.
They also contain helper methods/classes to aid with other tasks such as indexing and auditing the LLM calls.
## Installation
- The below libraries need to be installed to run the SDK
- Linux
```
sudo apt install build-essential pkg-config libmagic-dev tesseract-ocr pandoc
```
- Mac
```
brew install pkg-config libmagic pandoc tesseract-ocr
```
## Tools
### Create a scaffolding for a new tool
Example
```bash
unstract-tool-gen --command NEW --tool-name <name of tool> \
--location ~/path_to_repository/unstract-tools/ --overwrite false
```
Supported commands:
- `NEW` - Create a new tool
### Environment variables required for all Tools
| Variable | Description |
| -------------------------- | --------------------------------------------------------------------- |
| `PLATFORM_SERVICE_HOST` | The host in which the platform service is running |
| `PLATFORM_SERVICE_PORT` | The port in which the service is listening |
| `PLATFORM_SERVICE_API_KEY` | The API key for the platform |
| `TOOL_DATA_DIR` | The directory in the filesystem which has contents for tool execution |
### Llama Index support
Unstract SDK 0.3.2 uses the following version of Llama
Index Version **0.9.28** as on January 14th, 2024
### Environment variables required for various LLMs (deprecated)
- Azure OpenAI
- `OPENAI_API_KEY`
- `OPENAI_API_BASE`
- `OPENAI_API_VERSION`
- `OPENAI_API_ENGINE`
- `OPENAI_API_MODEL`
### Documentation generation
Follow [this README.md](docs/README.md) for generating documentation.
Raw data
{
"_id": null,
"home_page": null,
"name": "unstract-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.11.1,>=3.9",
"maintainer_email": null,
"keywords": "unstract tools-development-kit apps development-kit sdk",
"author": null,
"author_email": "Zipstack Inc <devsupport@zipstack.com>",
"download_url": "https://files.pythonhosted.org/packages/19/f4/e729c5930108d49d91cc462e5a6e2e7ea607c9e970ee2ae8d7d7f28005f4/unstract_sdk-0.24.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<img src=\"docs/assets/unstract_u_logo.png\" style=\"height: 120px\">\n\n# Unstract\n\n## No-code LLM Platform to launch APIs and ETL Pipelines to structure unstructured documents\n\n</div>\n\n# Unstract SDK\n\nThe `unstract-sdk` package helps with developing tools that are meant to be run on the Unstract platform. This includes\nmodules to help with tool development and execution, caching, making calls to LLMs / vectorDBs / embeddings .etc.\nThey also contain helper methods/classes to aid with other tasks such as indexing and auditing the LLM calls.\n\n## Installation\n\n- The below libraries need to be installed to run the SDK\n - Linux\n\n ```\n sudo apt install build-essential pkg-config libmagic-dev tesseract-ocr pandoc\n ```\n\n - Mac\n\n ```\n brew install pkg-config libmagic pandoc tesseract-ocr\n ```\n\n## Tools\n\n### Create a scaffolding for a new tool\n\nExample\n\n```bash\nunstract-tool-gen --command NEW --tool-name <name of tool> \\\n --location ~/path_to_repository/unstract-tools/ --overwrite false\n```\n\nSupported commands:\n\n- `NEW` - Create a new tool\n\n### Environment variables required for all Tools\n\n| Variable | Description |\n| -------------------------- | --------------------------------------------------------------------- |\n| `PLATFORM_SERVICE_HOST` | The host in which the platform service is running |\n| `PLATFORM_SERVICE_PORT` | The port in which the service is listening |\n| `PLATFORM_SERVICE_API_KEY` | The API key for the platform |\n| `TOOL_DATA_DIR` | The directory in the filesystem which has contents for tool execution |\n\n### Llama Index support\n\nUnstract SDK 0.3.2 uses the following version of Llama\nIndex Version **0.9.28** as on January 14th, 2024\n\n### Environment variables required for various LLMs (deprecated)\n\n- Azure OpenAI\n - `OPENAI_API_KEY`\n - `OPENAI_API_BASE`\n - `OPENAI_API_VERSION`\n - `OPENAI_API_ENGINE`\n - `OPENAI_API_MODEL`\n\n### Documentation generation\n\nFollow [this README.md](docs/README.md) for generating documentation.\n",
"bugtrack_url": null,
"license": "AGPL v3",
"summary": "A framework for writing Unstract Tools/Apps",
"version": "0.24.0",
"project_urls": {
"Homepage": "https://unstract.com",
"Release notes": "https://github.com/Zipstack/unstract-sdk/releases",
"Source": "https://github.com/Zipstack/unstract-sdk"
},
"split_keywords": [
"unstract",
"tools-development-kit",
"apps",
"development-kit",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "280668d6459d23aa16a190c6a5ce703aa59add546eeb3d8a59a69a1ea85ae7ea",
"md5": "e6626340df28f2a6b76dd2cf094ef758",
"sha256": "bbbfdb814d48b2a0a0914ca9328bcea0ad26acf34ca9348f64c822949c80dcc1"
},
"downloads": -1,
"filename": "unstract_sdk-0.24.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6626340df28f2a6b76dd2cf094ef758",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11.1,>=3.9",
"size": 64323,
"upload_time": "2024-05-02T04:31:28",
"upload_time_iso_8601": "2024-05-02T04:31:28.478975Z",
"url": "https://files.pythonhosted.org/packages/28/06/68d6459d23aa16a190c6a5ce703aa59add546eeb3d8a59a69a1ea85ae7ea/unstract_sdk-0.24.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "19f4e729c5930108d49d91cc462e5a6e2e7ea607c9e970ee2ae8d7d7f28005f4",
"md5": "3f555c5ae85ec5e89fec3a3bda0579b9",
"sha256": "76e52e15dbb24fd9157f704186d80c6fcff2a3b1d17c30652b958ff024cdb10e"
},
"downloads": -1,
"filename": "unstract_sdk-0.24.0.tar.gz",
"has_sig": false,
"md5_digest": "3f555c5ae85ec5e89fec3a3bda0579b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11.1,>=3.9",
"size": 56329,
"upload_time": "2024-05-02T04:31:30",
"upload_time_iso_8601": "2024-05-02T04:31:30.449122Z",
"url": "https://files.pythonhosted.org/packages/19/f4/e729c5930108d49d91cc462e5a6e2e7ea607c9e970ee2ae8d7d7f28005f4/unstract_sdk-0.24.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 04:31:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Zipstack",
"github_project": "unstract-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "unstract-sdk"
}