<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/67/d1/dc07c84cff47d3cdb94f12352a379490cd1960a8bdabc015bd8d28453c6b/unstract_sdk-0.22.1.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.22.1",
"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": "afd46dffb436a6fbeea7c8b0c6e294f0aa9418841572fafd8b9bb1e8d707ed6d",
"md5": "f8ae97908a5c498cd3dd90c1eb28296a",
"sha256": "af29fec4c56c3c1916b7af639d331d9c7b115ebff6f1183e4be50bef01bd1792"
},
"downloads": -1,
"filename": "unstract_sdk-0.22.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8ae97908a5c498cd3dd90c1eb28296a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11.1,>=3.9",
"size": 64328,
"upload_time": "2024-04-25T09:48:02",
"upload_time_iso_8601": "2024-04-25T09:48:02.934572Z",
"url": "https://files.pythonhosted.org/packages/af/d4/6dffb436a6fbeea7c8b0c6e294f0aa9418841572fafd8b9bb1e8d707ed6d/unstract_sdk-0.22.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67d1dc07c84cff47d3cdb94f12352a379490cd1960a8bdabc015bd8d28453c6b",
"md5": "74d8270eebcd952557a931637daa83d3",
"sha256": "f49db6c62bca6baa2474912a63f305df01ec12ada34af9a2fb93b8ce91e7fa16"
},
"downloads": -1,
"filename": "unstract_sdk-0.22.1.tar.gz",
"has_sig": false,
"md5_digest": "74d8270eebcd952557a931637daa83d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11.1,>=3.9",
"size": 56327,
"upload_time": "2024-04-25T09:48:04",
"upload_time_iso_8601": "2024-04-25T09:48:04.982844Z",
"url": "https://files.pythonhosted.org/packages/67/d1/dc07c84cff47d3cdb94f12352a379490cd1960a8bdabc015bd8d28453c6b/unstract_sdk-0.22.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 09:48:04",
"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"
}
JSON
