unstract-client 0.1.0__tar.gz

unstract_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zipstack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

unstract_client-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: unstract-client
+Version: 0.1.0
+Summary: Python client for the Unstract LLM-powered structured data extraction platform
+Keywords: unstract cli apps sdk
+Author-Email: Zipstack Inc <devsupport@zipstack.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: Homepage, https://unstract.com
+Project-URL: Source, https://github.com/Zipstack/unstract-python-client
+Requires-Python: >=3.11
+Requires-Dist: requests>=2.32.3
+Description-Content-Type: text/markdown
+
+# unstract-python-client
+Python client for the Unstract LLM-powered structured data extraction platform
+
+
+## Installation
+
+You can install the Unstract Python Client using pip:
+
+```bash
+pip install unstract-client
+```
+
+## Usage
+
+First, import the `APIDeploymentsClient` from the `client` module:
+
+```python
+from unstract.api_deployments.client import APIDeploymentsClient
+```
+
+Then, create an instance of the `APIDeploymentsClient`:
+
+```python
+client = APIDeploymentsClient(api_url="url", api_key="your_api_key")
+```
+
+Now, you can use the client to interact with the Unstract API deployments API:
+
+```python
+try:
+    adc = APIDeploymentsClient(
+        api_url=os.getenv("UNSTRACT_API_URL"),
+        api_key=os.getenv("UNSTRACT_API_DEPLOYMENT_KEY"),
+        api_timeout=10,
+        logging_level="DEBUG",
+    )
+    # Replace files with pdfs
+    response = adc.structure_file(
+        ["<files>"]
+    )
+    print(response)
+    if response["pending"]:
+        while True:
+            p_response = adc.check_execution_status(
+                response["status_check_api_endpoint"]
+            )
+            print(p_response)
+            if not p_response["pending"]:
+                break
+            print("Sleeping and checking again in 5 seconds..")
+            time.sleep(5)
+except APIDeploymentsClientException as e:
+    print(e)
+```
+
+
+## Questions and Feedback
+
+On Slack, [join great conversations](https://join-slack.unstract.com/) around LLMs, their ecosystem and leveraging them to automate the previously unautomatable!
+
+[Unstract Cloud](https://unstract.com/): Signup and Try!
+
+[Unstract developer documentation](https://docs.unstract.com/): Learn more about Unstract and its API.

unstract_client-0.1.0/README.md

@@ -0,0 +1,63 @@
+# unstract-python-client
+Python client for the Unstract LLM-powered structured data extraction platform
+
+
+## Installation
+
+You can install the Unstract Python Client using pip:
+
+```bash
+pip install unstract-client
+```
+
+## Usage
+
+First, import the `APIDeploymentsClient` from the `client` module:
+
+```python
+from unstract.api_deployments.client import APIDeploymentsClient
+```
+
+Then, create an instance of the `APIDeploymentsClient`:
+
+```python
+client = APIDeploymentsClient(api_url="url", api_key="your_api_key")
+```
+
+Now, you can use the client to interact with the Unstract API deployments API:
+
+```python
+try:
+    adc = APIDeploymentsClient(
+        api_url=os.getenv("UNSTRACT_API_URL"),
+        api_key=os.getenv("UNSTRACT_API_DEPLOYMENT_KEY"),
+        api_timeout=10,
+        logging_level="DEBUG",
+    )
+    # Replace files with pdfs
+    response = adc.structure_file(
+        ["<files>"]
+    )
+    print(response)
+    if response["pending"]:
+        while True:
+            p_response = adc.check_execution_status(
+                response["status_check_api_endpoint"]
+            )
+            print(p_response)
+            if not p_response["pending"]:
+                break
+            print("Sleeping and checking again in 5 seconds..")
+            time.sleep(5)
+except APIDeploymentsClientException as e:
+    print(e)
+```
+
+
+## Questions and Feedback
+
+On Slack, [join great conversations](https://join-slack.unstract.com/) around LLMs, their ecosystem and leveraging them to automate the previously unautomatable!
+
+[Unstract Cloud](https://unstract.com/): Signup and Try!
+
+[Unstract developer documentation](https://docs.unstract.com/): Learn more about Unstract and its API.

unstract_client-0.1.0/pyproject.toml

@@ -0,0 +1,94 @@
+[project]
+name = "unstract-client"
+dynamic = []
+description = "Python client for the Unstract LLM-powered structured data extraction platform"
+authors = [
+    { name = "Zipstack Inc", email = "devsupport@zipstack.com" },
+]
+dependencies = [
+    "requests>=2.32.3",
+]
+requires-python = ">=3.11"
+readme = "README.md"
+keywords = [
+    "unstract cli apps sdk",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+version = "0.1.0"
+
+[project.urls]
+Homepage = "https://unstract.com"
+Source = "https://github.com/Zipstack/unstract-python-client"
+
+[project.license]
+text = "MIT"
+
+[tool.pdm.dev-dependencies]
+test = [
+    "pytest>=8.2.2",
+    "pytest-mock>=3.14.0",
+    "pytest-dotenv>=0.5.2",
+    "pytest-cov>=5.0.0",
+    "pytest-md-report>=0.6.2",
+]
+lint = [
+    "autopep8~=2.0.2",
+    "black~=23.3.0",
+    "docutils~=0.20.1",
+    "flake8~=6.0.0",
+    "flake8-pyproject~=1.2.2",
+    "isort~=5.12.0",
+    "pre-commit~=3.3.1",
+    "yamllint>=1.35.1",
+    "mypy~=1.10.0",
+]
+
+[tool.pdm.version]
+source = "file"
+path = "src/unstract/api_deployments/__init__.py"
+
+[tool.pdm.build]
+includes = [
+    "src",
+]
+package-dir = "src"
+
+[tool.pdm.scripts.test]
+cmd = "pytest -s -v"
+env_file = "tests/.env"
+help = "Runs pytests for Unstract client"
+
+[tool.isort]
+line_length = 120
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+profile = "black"
+
+[tool.flake8]
+max-line-length = 120
+
+[tool.pytest.ini_options]
+env_files = [
+    "tests/.env",
+]
+addopts = "-s"
+log_level = "INFO"
+log_cli = true
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"

unstract_client-0.1.0/src/unstract/api_deployments/__init__.py

@@ -0,0 +1,7 @@
+__version__ = "0.1.0"
+
+from .client import APIDeploymentsClient
+
+
+def get_sdk_version():
+    return __version__

unstract_client-0.1.0/src/unstract/api_deployments/client.py

@@ -0,0 +1,222 @@
+"""
+This module provides an API client to invoke APIs deployed on the Unstract platform.
+
+Classes:
+    APIDeploymentsClient: A class to invoke APIs deployed on the Unstract platform.
+    APIDeploymentsClientException: A class to handle exceptions raised by the APIDeploymentsClient class.
+"""
+
+import logging
+import ntpath
+import os
+from urllib.parse import parse_qs, urlparse
+
+import requests
+
+from unstract.api_deployments.utils import UnstractUtils
+
+
+class APIDeploymentsClientException(Exception):
+    """
+    A class to handle exceptions raised by the APIClient class.
+    """
+
+    def __init__(self, message):
+        def __init__(self, value):
+            self.value = value
+
+        def __str__(self):
+            return repr(self.value)
+
+        def error_message(self):
+            return self.value
+
+
+class APIDeploymentsClient:
+    """
+    A class to invoke APIs deployed on the Unstract platform.
+    """
+
+    formatter = logging.Formatter(
+        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
+    logger = logging.getLogger(__name__)
+    log_stream_handler = logging.StreamHandler()
+    log_stream_handler.setFormatter(formatter)
+    logger.addHandler(log_stream_handler)
+
+    api_key = ""
+    api_timeout = 300
+
+    def __init__(
+        self,
+        api_url: str,
+        api_key: str,
+        api_timeout: int = 300,
+        logging_level: str = "INFO",
+    ):
+        """
+        Initializes the APIClient class.
+
+        Args:
+            api_key (str): The API key to authenticate the API request.
+            api_timeout (int): The timeout to wait for the API response.
+            logging_level (str): The logging level to log messages.
+        """
+        if logging_level == "":
+            logging_level = os.getenv("UNSTRACT_API_CLIENT_LOGGING_LEVEL", "INFO")
+        if logging_level == "DEBUG":
+            self.logger.setLevel(logging.DEBUG)
+        elif logging_level == "INFO":
+            self.logger.setLevel(logging.INFO)
+        elif logging_level == "WARNING":
+            self.logger.setLevel(logging.WARNING)
+        elif logging_level == "ERROR":
+            self.logger.setLevel(logging.ERROR)
+
+        # self.logger.setLevel(logging_level)
+        self.logger.debug("Logging level set to: " + logging_level)
+
+        if api_key == "":
+            self.api_key = os.getenv("UNSTRACT_API_DEPLOYMENT_KEY", "")
+        else:
+            self.api_key = api_key
+        self.logger.debug("API key set to: " + UnstractUtils.redact_key(self.api_key))
+
+        self.api_timeout = api_timeout
+        self.api_url = api_url
+        self.__save_base_url(api_url)
+
+    def __save_base_url(self, full_url: str):
+        """
+        Extracts the base URL from the full URL and saves it.
+
+        Args:
+            full_url (str): The full URL of the API.
+        """
+        parsed_url = urlparse(full_url)
+        self.base_url = parsed_url.scheme + "://" + parsed_url.netloc
+        self.logger.debug("Base URL: " + self.base_url)
+
+    def structure_file(self, file_paths: list[str]) -> dict:
+        """
+        Invokes the API deployed on the Unstract platform.
+
+        Args:
+            file_paths (list[str]): The file path to the file to be uploaded.
+
+        Returns:
+            dict: The response from the API.
+        """
+        self.logger.debug("Invoking API: " + self.api_url)
+        self.logger.debug("File paths: " + str(file_paths))
+
+        headers = {
+            "Authorization": "Bearer " + self.api_key,
+        }
+
+        data = {"timeout": self.api_timeout}
+
+        files = []
+
+        try:
+            for file_path in file_paths:
+                record = (
+                    "files",
+                    (
+                        ntpath.basename(file_path),
+                        open(file_path, "rb"),
+                        "application/octet-stream",
+                    ),
+                )
+                files.append(record)
+        except FileNotFoundError as e:
+            raise APIDeploymentsClientException("File not found: " + str(e))
+
+        response = requests.post(
+            self.api_url,
+            headers=headers,
+            data=data,
+            files=files,
+        )
+        self.logger.debug(response.status_code)
+        self.logger.debug(response.text)
+        # The returned object is wrapped in a "message" key. Let's simplify the response.
+        obj_to_return = {}
+
+        if response.status_code == 401:
+            obj_to_return = {
+                "pending": False,
+                "execution_status": "",
+                "error": response.json()["errors"][0]["detail"],
+                "extraction_result": "",
+                "status_code": response.status_code,
+            }
+            return obj_to_return
+
+        # If the execution status is pending, extract the execution ID from the response
+        # and return it in the response. Later, users can use the execution ID to check the status of the execution.
+        # The returned object is wrapped in a "message" key. Let's simplify the response.
+        obj_to_return = {
+            "pending": False,
+            "execution_status": response.json()["message"]["execution_status"],
+            "error": response.json()["message"]["error"],
+            "extraction_result": response.json()["message"]["result"],
+            "status_code": response.status_code,
+        }
+        if (
+            200 <= response.status_code < 300
+            and obj_to_return["execution_status"] == "PENDING"
+        ):
+
+            obj_to_return["status_check_api_endpoint"] = response.json()["message"][
+                "status_api"
+            ]
+            obj_to_return["pending"] = True
+
+        return obj_to_return
+
+    def check_execution_status(self, status_check_api_endpoint: str) -> dict:
+        """
+        Checks the status of the execution.
+
+        Args:
+            status_check_api_endpoint (str): The API endpoint to check the status of the execution.
+
+        Returns:
+            dict: The response from the API.
+        """
+
+        headers = {
+            "Authorization": "Bearer " + self.api_key,
+        }
+        status_call_url = self.base_url + status_check_api_endpoint
+        self.logger.debug("Checking execution status via endpoint: " + status_call_url)
+        response = requests.get(
+            status_call_url,
+            headers=headers,
+        )
+        self.logger.debug(response.status_code)
+        self.logger.debug(response.text)
+        obj_to_return = {
+            "pending": False,
+            "execution_status": response.json()["status"],
+            "status_code": response.status_code,
+            "message": response.json()["message"],
+        }
+
+        # If the execution status is pending, extract the execution ID from the response
+        # and return it in the response. Later, users can use the execution ID to check the status of the execution.
+        if (
+            200 <= response.status_code < 500
+            and obj_to_return["execution_status"] == "PENDING"
+        ):
+            obj_to_return["pending"] = True
+
+        if (
+            200 <= response.status_code < 300
+            and obj_to_return["execution_status"] == "SUCCESS"
+        ):
+            obj_to_return["extraction_result"] = response.json()["message"]
+
+        return obj_to_return

unstract_client-0.1.0/src/unstract/api_deployments/utils.py

@@ -0,0 +1,22 @@
+class UnstractUtils:
+    @staticmethod
+    def redact_key(api_key: str, reveal_length=4) -> str:
+        """Hides sensitive information partially. Useful for logging keys.
+
+        Args:
+            api_key (str): API key to redact
+            reveal_length (int): Number of characters to reveal from the start of the key
+
+        Returns:
+            str: Redacted API key
+        """
+        if not isinstance(api_key, str):
+            raise ValueError("API key must be a string")
+
+        if reveal_length < 0:
+            raise ValueError("Reveal length must be a non-negative integer")
+
+        redacted_length = max(len(api_key) - reveal_length, 0)
+        revealed_part = api_key[:reveal_length]
+        redacted_part = "x" * redacted_length
+        return revealed_part + redacted_part

unstract_client-0.1.0/tests/client_test.py

@@ -0,0 +1,40 @@
+import time
+import os
+
+from unstract.api_deployments.client import (
+    APIDeploymentsClient,
+    APIDeploymentsClientException,
+)
+import dotenv
+
+dotenv.load_dotenv()
+
+def main():
+    try:
+        adc = APIDeploymentsClient(
+            api_url=os.getenv("API_URL"),
+            api_key=os.getenv("UNSTRACT_API_DEPLOYMENT_KEY"),
+            api_timeout=10,
+            logging_level="DEBUG",
+        )
+        # Replace files with pdfs
+        response = adc.structure_file(
+            ["<files>"]
+        )
+        print(response)
+        if response["pending"]:
+            while True:
+                p_response = adc.check_execution_status(
+                    response["status_check_api_endpoint"]
+                )
+                print(p_response)
+                if not p_response["pending"]:
+                    break
+                print("Sleeping and checking again in 5 seconds..")
+                time.sleep(5)
+    except APIDeploymentsClientException as e:
+        print(e)
+
+
+if __name__ == "__main__":
+    main()

unstract_client-0.1.0/tests/sample.env

@@ -0,0 +1,2 @@
+API_URL=
+UNSTRACT_API_DEPLOYMENT_KEY=