itzam 1.0.0__tar.gz

itzam-1.0.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: itzam
+Version: 1.0.0
+Summary: Python SDK to interact with Itzam's API
+Author-email: Joaquim Cassano <joaquim@cassano.com.br>
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic
+Requires-Dist: requests
+Requires-Dist: rich
+
+# Itzam python sdk
+![itzam logo](https://pbs.twimg.com/profile_banners/1930643525021937664/1749136962/600x200)
+
+## Overview
+
+Itzam Python SDK provides a simple interface to interact with the [Itzam API](https://itz.am) for text generation, thread management, model listing, and run inspection.
+
+## Installation
+
+```bash
+pip install itzam
+```
+
+## Quick Start
+
+```python
+from itzam import Itzam
+
+client = Itzam("your-api-key")
+response = client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Hello, Itzam!",
+  stream=False
+)
+print(response.text)
+```
+
+## Authentication
+
+You can provide your API key directly or set it as an environment variable:
+
+```bash
+export ITZAM_API_KEY=your-api-key
+```
+
+Then initialize without arguments:
+
+```python
+from itzam import Itzam
+client = Itzam()
+```
+
+## Features
+
+- **Text Generation**: Generate text using your workflows.
+- **Threads**: Create and manage threads for conversations.
+- **Models**: List available models and their details.
+- **Runs**: Inspect previous runs and their metadata.
+
+## Usage Examples
+
+### Generate Text
+
+```python
+response = client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Write a poem about the sea."
+)
+print(response.text)
+```
+
+### Stream Text Generation
+
+```python
+for delta in client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Tell me a story.",
+  stream=True
+):
+  print(delta, end="", flush=True)
+```
+
+### List Models
+
+```python
+models = client.models.list()
+for model in models:
+  print(model.name, model.tag)
+```
+
+### Create a Thread
+
+```python
+thread = client.threads.create(
+  workflow_slug="your_workflow_slug",
+  name="Support Conversation"
+)
+print(thread.id)
+```
+
+### Get a Run
+
+```python
+run = client.runs.get("run_id")
+print(run.output)
+```
+
+## Advanced
+
+You can specify a custom API base URL if needed:
+
+```python
+client = Itzam(api_key="your-api-key", base_url="https://itz.am")
+```
+
+## Requirements
+
+- Python 3.10+
+- `requests`
+- `pydantic`
+- `rich`
+- `python-dotenv` (optional, for environment variable loading)
+
+## License
+
+MIT
+
+---
+
+For more details, see the [API documentation](https://itz.am).

itzam-1.0.0/README.md

@@ -0,0 +1,120 @@
+# Itzam python sdk
+![itzam logo](https://pbs.twimg.com/profile_banners/1930643525021937664/1749136962/600x200)
+
+## Overview
+
+Itzam Python SDK provides a simple interface to interact with the [Itzam API](https://itz.am) for text generation, thread management, model listing, and run inspection.
+
+## Installation
+
+```bash
+pip install itzam
+```
+
+## Quick Start
+
+```python
+from itzam import Itzam
+
+client = Itzam("your-api-key")
+response = client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Hello, Itzam!",
+  stream=False
+)
+print(response.text)
+```
+
+## Authentication
+
+You can provide your API key directly or set it as an environment variable:
+
+```bash
+export ITZAM_API_KEY=your-api-key
+```
+
+Then initialize without arguments:
+
+```python
+from itzam import Itzam
+client = Itzam()
+```
+
+## Features
+
+- **Text Generation**: Generate text using your workflows.
+- **Threads**: Create and manage threads for conversations.
+- **Models**: List available models and their details.
+- **Runs**: Inspect previous runs and their metadata.
+
+## Usage Examples
+
+### Generate Text
+
+```python
+response = client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Write a poem about the sea."
+)
+print(response.text)
+```
+
+### Stream Text Generation
+
+```python
+for delta in client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Tell me a story.",
+  stream=True
+):
+  print(delta, end="", flush=True)
+```
+
+### List Models
+
+```python
+models = client.models.list()
+for model in models:
+  print(model.name, model.tag)
+```
+
+### Create a Thread
+
+```python
+thread = client.threads.create(
+  workflow_slug="your_workflow_slug",
+  name="Support Conversation"
+)
+print(thread.id)
+```
+
+### Get a Run
+
+```python
+run = client.runs.get("run_id")
+print(run.output)
+```
+
+## Advanced
+
+You can specify a custom API base URL if needed:
+
+```python
+client = Itzam(api_key="your-api-key", base_url="https://itz.am")
+```
+
+## Requirements
+
+- Python 3.10+
+- `requests`
+- `pydantic`
+- `rich`
+- `python-dotenv` (optional, for environment variable loading)
+
+## License
+
+MIT
+
+---
+
+For more details, see the [API documentation](https://itz.am).

itzam-1.0.0/itzam/__init__.py

@@ -0,0 +1,40 @@
+"""
+The Python sdk for the Itzam API.
+Example usage:
+
+```python
+from itzam import Itzam
+
+client = Itzam("your api key")
+response = client.text.generate(
+    workflow_slug="your_workflow_slug",
+    input="your input text",
+    stream=False
+)
+print(response.text)
+```
+"""
+from .text.client import TextClient
+from .threads import ThreadsClient
+from .runs import RunsClient
+from .models import ModelsClient
+import dotenv, os
+
+class Itzam:
+  def __init__(self, api_key: str|None = None, base_url: str="https://itz.am"):
+    """
+    Initialize the Itzam SDK with the base URL and API key. If no API key is provided, it will look for the `ITZAM_API_KEY` environment variable.
+
+    :param base_url: The base URL for the Itzam API.
+    :param api_key: The API key for authentication.
+    """
+    if not api_key:
+      dotenv.load_dotenv()
+      api_key = os.getenv("ITZAM_API_KEY")
+      if not api_key:
+        raise ValueError("API key is required. Please provide it as an argument or set the ITZAM_API_KEY environment variable.")
+
+    self.text = TextClient(base_url=base_url, api_key=api_key)
+    self.threads = ThreadsClient(base_url=base_url, api_key=api_key)
+    self.runs = RunsClient(base_url=base_url, api_key=api_key)
+    self.models = ModelsClient(base_url=base_url, api_key=api_key)

itzam-1.0.0/itzam/base/__init__.py

@@ -0,0 +1,3 @@
+"""
+Module responsible for managing all objects that serve as a foundation for other objects.
+"""

itzam-1.0.0/itzam/base/client.py

@@ -0,0 +1,34 @@
+import requests
+from ..utils.exceptions import raise_for_status
+import logging
+logger = logging.getLogger(__name__)
+class BaseClient:
+    """    Base client for making HTTP requests to the Itzam API.
+    This class should be extended by specific API clients.
+    It handles the common functionality of making requests, including setting headers and handling errors.
+    """
+    def __init__(self, api_key: str, base_url: str):
+        self.base_url = base_url
+        self.api_key = api_key
+
+    def request(self, method: str, endpoint: str, params: dict = None, data: dict = None,  **kwargs):
+        url = f"{self.base_url}{endpoint}"
+        headers = {
+            "Content-Type": "application/json",
+            "User-Agent": "Itzam-Python-SDK/1.0",
+            "Api-Key": self.api_key
+        }
+
+        response = requests.request(method, url, headers=headers, params=params, json=data, **kwargs)
+
+        logger.debug(f"Request URL: {response.request.url}")
+        logger.debug(f"Request Method: {response.request.method}")
+        logger.debug(f"Request Headers: {response.request.headers}")
+        logger.debug(f"Request Body: {response.request.body}")
+        logger.debug(f"Response Status Code: {response.status_code}")
+        logger.debug(f"Response body: {response.text}")
+
+        if response.status_code != 200:
+            raise_for_status(response)
+
+        return response

itzam-1.0.0/itzam/models/__init__.py

@@ -0,0 +1,6 @@
+from .client import ModelsClient
+
+__all__ = [
+    "ModelsClient",
+]
+

itzam-1.0.0/itzam/models/__main__.py

@@ -0,0 +1,28 @@
+from .client import ModelsClient
+
+if __name__ == "__main__":
+    from rich.console import Console
+    from rich.table import Table
+    import dotenv,  os
+    dotenv.load_dotenv()
+    client = ModelsClient(base_url="https://itz.am", api_key=os.getenv("ITZAM_API_KEY"))
+    models = client.list()
+    console = Console()
+
+    table = Table(title="Models List")
+    table.add_column("Name", style="cyan", no_wrap=True)
+    table.add_column("Tag", style="magenta")
+    table.add_column("Deprecated", style="red")
+    table.add_column("Open Source", style="green")
+    table.add_column("Context Window Size", style="yellow")
+
+    for model in models:
+      table.add_row(
+        model.name,
+        model.tag,
+        "Yes" if model.deprecated else "No",
+        "Yes" if model.isOpenSource else "No",
+        str(model.contextWindowSize)
+      )
+
+    console.print(table)

itzam-1.0.0/itzam/models/client.py

@@ -0,0 +1,18 @@
+from .models import Model
+from ..base.client import BaseClient
+
+class ModelsClient(BaseClient):
+    """
+    Client for interacting with the Itzam Models API.
+    """
+
+    def __init__(self, base_url: str, api_key: str):
+        super().__init__(base_url=base_url, api_key=api_key)
+
+    def list(self) -> list[Model]:
+        """
+        List all available models.
+        """
+        endpoint = "/api/v1/models"
+        response = self.request(method="GET", endpoint=endpoint)
+        return [Model.model_validate(model) for model in response.json().get("models", [])]

itzam-1.0.0/itzam/models/models.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel, Field
+
+class Provider(BaseModel):
+  name: str
+
+class Model(BaseModel):
+  name: str
+  tag: str
+  deprecated: bool
+  hasVision: bool
+  hasReasoningCapability: bool
+  isOpenSource: bool
+  contextWindowSize: int
+  inputPerMillionTokenCost: float
+  outputPerMillionTokenCost: float
+  provider: Provider

itzam-1.0.0/itzam/runs/__init__.py

@@ -0,0 +1,5 @@
+from .client import RunsClient
+
+__all__ = [
+    "RunsClient",
+]

itzam-1.0.0/itzam/runs/client.py

@@ -0,0 +1,18 @@
+from .models import Run
+from ..base.client import BaseClient
+
+class RunsClient(BaseClient):
+    """
+    Client for interacting with the Itzam Runs API.
+    """
+
+    def __init__(self, base_url: str, api_key: str):
+        super().__init__(base_url=base_url, api_key=api_key)
+
+    def get(self, run_id: str) -> Run:
+        """
+        Get a run by its ID.
+        """
+        endpoint = f"/api/v1/runs/{run_id}"
+        response = self.request(method="GET", endpoint=endpoint)
+        return Run.model_validate(response.json())

itzam-1.0.0/itzam/runs/models.py

@@ -0,0 +1,34 @@
+from pydantic import BaseModel, Field
+from typing import List, Optional
+from datetime import datetime
+from ..text.models import ModelInput as Model, Attachment
+
+
+class AttachmentResponse(Attachment):
+  id: str
+
+
+class Knowledge(BaseModel):
+  id: str
+  title: str
+  url: str
+  type: str
+
+
+class Run(BaseModel):
+  id: str
+  origin: str
+  status: str
+  input: str
+  output: str
+  prompt: str
+  input_tokens: int = Field(alias="inputTokens")
+  output_tokens: int = Field(alias="outputTokens")
+  cost: str
+  duration_in_ms: int = Field(alias="durationInMs")
+  thread_id: str|None = Field(alias="threadId", default=None)
+  model: Model
+  attachments: List[Attachment] = Field(default=[])
+  knowledge: List[Knowledge ] = Field(default=[])
+  workflow_id: str = Field(alias="workflowId")
+  created_at: datetime = Field(alias="createdAt")

itzam-1.0.0/itzam/text/__init__.py

@@ -0,0 +1,14 @@
+from .client import TextClient
+from .models import (
+    Attachment,
+    ModelInput,
+    ResponseMetadata,
+    Response
+)
+
+__all__ = ["TextClient",
+           "Attachment",
+           "ModelInput",
+           "ResponseMetadata",
+           "Response"
+        ]

itzam-1.0.0/itzam/text/client.py

@@ -0,0 +1,60 @@
+import requests
+from .models import (
+    Attachment,
+    ModelInput,
+    ResponseMetadata,
+    Response
+)
+from ..base.client import BaseClient
+import json
+
+class TextClient(BaseClient):
+    """
+    Client for interacting with the Itzam Text API.
+    """
+
+    def __init__(self, base_url: str, api_key: str):
+        super().__init__(base_url=base_url, api_key=api_key)
+
+    def generate(
+        self,
+        input: str,
+        workflow_slug: str | None = None,
+        thread_id: str | None = None,
+        attachments: list[Attachment] = None,
+        stream: bool = False
+    ):
+        """
+        Generate text using the specified model and prompt.
+        If stream=True, returns a generator yielding text deltas.
+        """
+        if not workflow_slug and not thread_id:
+            raise ValueError("Either 'thread_id' or 'worflow_slug' must be provided.")
+        endpoint = "/api/v1/generate/text"
+        data = {
+            "input": input,
+            "workflowSlug": workflow_slug,
+            **({"threadId": thread_id} if thread_id else {}),
+            **({"attachments": [attachment.model_dump() for attachment in attachments]} if attachments else {})
+        }
+
+        if stream == True:
+            return self._stream_text("/api/v1/stream/text", data)
+        else:
+            response = self.request(method="POST", endpoint=endpoint, data=data)
+            return Response.model_validate(response.json())
+
+    def _stream_text(self, endpoint, data):
+        """
+        Internal method to handle streaming text responses.
+        Yields text deltas as they arrive.
+        """
+        response = self.request(method="POST", endpoint=endpoint, data=data, stream=True)
+        for line in response.iter_lines():
+            if line:
+                try:
+                    event = json.loads(line.decode("utf-8").removeprefix("data: "))
+                    if event.get("type") == "text-delta":
+                        yield event.get("textDelta")
+                except Exception as e:
+                    continue

itzam-1.0.0/itzam/text/models.py

@@ -0,0 +1,39 @@
+from pydantic import BaseModel, Field
+
+class Attachment(BaseModel):
+    """
+    Represents an attachment in a text message.
+    """
+    file: str = Field(
+        ...,
+        description="The file path or URL of the attachment. Either a base64 encoded string or a URL."
+    )
+    mimetype: str = Field(
+        ...,
+        description="The MIME type of the attachment, e.g., 'image/png', 'application/pdf'."
+    )
+
+class ModelInput(BaseModel):
+    """
+    Represents a model used for text generation.
+    """
+    name: str = Field(..., description="The name of the model used for this generation.")
+    tag: str = Field(..., description="The tag of the model used for text generation.")
+
+class ResponseMetadata(BaseModel):
+    """
+    Metadata for the response.
+    """
+    run_id: str = Field(alias="runId", description="The ID of the run created for this generation")
+    cost: str = Field(description="The cost of the generation in USD")
+    model: ModelInput
+    duration: int = Field( description="The duration of the generation in milliseconds", alias="durationInMs")
+    input_tokens: int = Field(alias="inputTokens", description="The number of input tokens used in the generation")
+    output_tokens: int = Field(alias="outputTokens", description="The number of output tokens used in this generation")
+
+class Response(BaseModel):
+    """
+    Represents the response from the text generation API.
+    """
+    text: str = Field(description="The generated text")
+    metadata: ResponseMetadata = Field(description="Metadata about the generation process")

itzam-1.0.0/itzam/threads/__init__.py

@@ -0,0 +1,7 @@
+from .client import ThreadsClient
+from .models import Thread
+
+__all__ = [
+    "ThreadsClient",
+    "Thread"
+]

itzam-1.0.0/itzam/threads/client.py

@@ -0,0 +1,53 @@
+from ..base.client import BaseClient
+from .models import (
+  Thread
+)
+
+class ThreadsClient(BaseClient):
+    """
+    Client for interacting with the Itzam Threads API.
+    """
+
+    def __init__(self, base_url: str, api_key: str):
+        super().__init__(base_url=base_url, api_key=api_key)
+
+    def create(self, workflow_slug:str, name:str|None = None, lookup_keys:list[str] = [], context_slugs:list[str] = []) -> Thread:
+        """
+        Create a new thread.
+        """
+        endpoint = "/api/v1/threads"
+        data = {
+            "workflowSlug": workflow_slug,
+            "name": name,
+        }
+        if lookup_keys:
+            data["lookupKeys"] = lookup_keys
+        if context_slugs:
+            data["contextSlugs"] = context_slugs
+        response = self.request(method="POST", endpoint=endpoint, data=data)
+        return Thread.model_validate(response.json())
+
+    def get(self, thread_id: str) -> Thread:
+        """
+        Get a thread by its ID.
+        """
+        endpoint = f"/api/v1/threads/{thread_id}"
+        response = self.request(method="GET", endpoint=endpoint)
+        return Thread.model_validate(response.json())
+
+    def from_workflow(self, workflow_slug: str) -> list[Thread]:
+        """
+        Get all threads for a specific workflow.
+        """
+        endpoint = f"/api/v1/threads/workflow/{workflow_slug}"
+        response = self.request(method="GET", endpoint=endpoint)
+        return [Thread.model_validate(thread) for thread in response.json().get("threads", [])]
+
+    def runs_from_thread(self, thread_id: str) -> list[dict]:
+        """
+        Get all runs for a specific thread.
+        """
+        endpoint = f"/api/v1/threads/{thread_id}/runs"
+        response = self.request(method="GET", endpoint=endpoint)
+        return response.json().get("runs", [])
+

itzam-1.0.0/itzam/threads/models.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel, Field
+
+class Thread(BaseModel):
+    name: str | None = Field(default=None, description="The name of the thread (optional, will auto-generate if not provided)")
+    lookup_keys: list[str] | None = Field(default=None, description="Optional lookup keys for finding the thread later", alias="lookupKeys")
+    context_slugs: list[str] | None = Field(default=None, description="Optional context slugs to append the context to the thread", alias="contextSlugs")
+    created_at: str | None = Field(default=None, description="The date and time when the thread was created", alias="createdAt")
+    updated_at: str | None = Field(default=None, description="The date and time when the thread was last updated", alias="updatedAt")
+    id: str = Field(..., description="The unique identifier for the thread")
+
+

itzam-1.0.0/itzam/utils/exceptions.py

@@ -0,0 +1,187 @@
+from http import HTTPStatus
+from typing import Literal
+
+import requests
+
+
+class APIError(Exception):
+    """The exception was raised due to an API error."""
+
+    message: str
+    request: str
+
+    def __init__(self, message: str, request: requests.Request) -> None:
+        super().__init__(message)
+        self.message = """The exception was raised due to an API error."""
+        self.request = request
+
+    def __str__(self) -> str:
+        if self.message:
+            return f'{self.message}'
+        return ''
+
+
+class APIStatusError(APIError):
+    """Raised when an API response has a status code of 4xx or 5xx."""
+
+    response: requests.Response
+    status_code: int
+
+    def __init__(
+        self, message: str = '', *, response: requests.Response
+    ) -> None:
+        super().__init__(message, response.request)
+        self.response = response
+        self.status_code = response.status_code
+
+
+class ForbiddenRequest(APIStatusError):
+    """
+    Means that the request was unsuccessful due to a forbidden request.
+    Maybe your API key is wrong?
+    """
+
+    status_code: Literal[HTTPStatus.FORBIDDEN]
+
+    def __init__(self, response: requests.Response, message: str = ''):
+        super().__init__(message, response=response)
+        self.message = (
+            'Means that the request was unsuccessful due to a '
+            'forbidden request. Maybe your API key is wrong?'
+        )
+        self.response = response
+        self.status_code = HTTPStatus.FORBIDDEN
+
+    def __str__(self) -> str:
+        if self.message:
+            return (
+                f'{self.message} \n Status Code: {self.response.status_code}'
+                f' | Response: {self.response.text}'
+            )
+        return str(self.response.content, 'utf-8')
+
+
+class UnauthorizedRequest(APIStatusError):
+    """
+    Means that the request was unsuccessful due to a forbidden request.
+    Maybe your API key doesn't have enought permissions
+    """
+
+    status_code: Literal[HTTPStatus.UNAUTHORIZED]
+
+    def __init__(self, response: requests.Response, message: str = ''):
+        super().__init__(message, response=response)
+        self.message = (
+            'Means that the request was unsuccessful due to a forbidden '
+            "request. Maybe your API key doesn't have enought permissions"
+        )
+        self.response = response
+        self.status_code = HTTPStatus.UNAUTHORIZED
+
+    def __str__(self) -> str:
+        if self.message:
+            return (
+                f'{self.message} | Status Code: {self.response.status_code}'
+                f' | Response: {self.response.text}'
+            )
+        return str(self.response.content, 'utf-8')
+
+
+class APIConnectionError(APIError):
+    """The request was unsuccessful due to a connection error.
+    Check your internet connection"""
+
+    def __init__(
+        self,
+        *,
+        message: str = (
+            'The request was unsuccessful due to a connection error.'
+            ' Check your internet connection'
+        ),
+        request: requests.Request,
+    ) -> None:
+        super().__init__(message, request)
+
+
+class APITimeoutError(APIConnectionError):
+    """The request got timed out. You might try checking
+    your internet connection."""
+
+    def __init__(self, request: requests.Request) -> None:
+        super().__init__(
+            message='Request timed out. Check your internet connection',
+            request=request,
+        )
+
+
+class BadRequestError(APIStatusError):
+    """The request was unsuccessful due to a bad request.
+    Maybe the request syntax is wrong"""
+
+    status_code: Literal[HTTPStatus.BAD_REQUEST]
+
+    def __init__(self, response: requests.Response) -> None:
+        self.response = response
+        self.status_code = HTTPStatus.BAD_REQUEST
+
+    def __str__(self) -> str:
+        return (
+            f'The request was unsuccessful due to a bad request. '
+            'Maybe the request syntax is wrong. Message error: '
+            f'{self.response.json()}'
+        )
+
+
+class NotFoundError(APIStatusError):
+    status_code: Literal[HTTPStatus.NOT_FOUND]
+
+    def __init__(
+        self, message: str = '', *, response: requests.Response
+    ) -> None:
+        super().__init__(message, response=response)
+        self.status_code = HTTPStatus.NOT_FOUND
+
+    def __str__(self) -> str:
+        return (
+            'The request was unsuccessful due to a not found error. '
+            f'Error status 404 | Requested URL: {self.response.url}'
+        )
+
+
+class InternalServerError(APIStatusError):
+    """The request was unsuccessful due to an internal server error."""
+
+    status_code: Literal[500] = 500
+
+    def __init__(self, response: requests.Response) -> None:
+        super().__init__(
+            message=(
+                'The request was unsuccessful due to an internal server error.'
+                " It's not your fault, just try again later."
+            ),
+            response=response,
+        )
+
+
+def raise_for_status(response: requests.Response) -> None:
+    code_exc_dict = {
+        HTTPStatus.BAD_REQUEST: BadRequestError(response=response),
+        HTTPStatus.UNAUTHORIZED: UnauthorizedRequest(response=response),
+        HTTPStatus.FORBIDDEN: ForbiddenRequest(response=response),
+        HTTPStatus.NOT_FOUND: NotFoundError(response=response),
+        HTTPStatus.INTERNAL_SERVER_ERROR: InternalServerError(
+            response=response
+        ),
+    }
+
+    code = response.status_code
+    if code == HTTPStatus.OK:
+        return
+
+    if code not in code_exc_dict and code >= HTTPStatus.BAD_REQUEST:
+        raise APIStatusError(message=response.text, response=response)
+
+    raise code_exc_dict.get(
+        response.status_code,
+        APIError(message=response.text, request=response.request),
+    )

itzam-1.0.0/itzam.egg-info/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: itzam
+Version: 1.0.0
+Summary: Python SDK to interact with Itzam's API
+Author-email: Joaquim Cassano <joaquim@cassano.com.br>
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic
+Requires-Dist: requests
+Requires-Dist: rich
+
+# Itzam python sdk
+![itzam logo](https://pbs.twimg.com/profile_banners/1930643525021937664/1749136962/600x200)
+
+## Overview
+
+Itzam Python SDK provides a simple interface to interact with the [Itzam API](https://itz.am) for text generation, thread management, model listing, and run inspection.
+
+## Installation
+
+```bash
+pip install itzam
+```
+
+## Quick Start
+
+```python
+from itzam import Itzam
+
+client = Itzam("your-api-key")
+response = client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Hello, Itzam!",
+  stream=False
+)
+print(response.text)
+```
+
+## Authentication
+
+You can provide your API key directly or set it as an environment variable:
+
+```bash
+export ITZAM_API_KEY=your-api-key
+```
+
+Then initialize without arguments:
+
+```python
+from itzam import Itzam
+client = Itzam()
+```
+
+## Features
+
+- **Text Generation**: Generate text using your workflows.
+- **Threads**: Create and manage threads for conversations.
+- **Models**: List available models and their details.
+- **Runs**: Inspect previous runs and their metadata.
+
+## Usage Examples
+
+### Generate Text
+
+```python
+response = client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Write a poem about the sea."
+)
+print(response.text)
+```
+
+### Stream Text Generation
+
+```python
+for delta in client.text.generate(
+  workflow_slug="your_workflow_slug",
+  input="Tell me a story.",
+  stream=True
+):
+  print(delta, end="", flush=True)
+```
+
+### List Models
+
+```python
+models = client.models.list()
+for model in models:
+  print(model.name, model.tag)
+```
+
+### Create a Thread
+
+```python
+thread = client.threads.create(
+  workflow_slug="your_workflow_slug",
+  name="Support Conversation"
+)
+print(thread.id)
+```
+
+### Get a Run
+
+```python
+run = client.runs.get("run_id")
+print(run.output)
+```
+
+## Advanced
+
+You can specify a custom API base URL if needed:
+
+```python
+client = Itzam(api_key="your-api-key", base_url="https://itz.am")
+```
+
+## Requirements
+
+- Python 3.10+
+- `requests`
+- `pydantic`
+- `rich`
+- `python-dotenv` (optional, for environment variable loading)
+
+## License
+
+MIT
+
+---
+
+For more details, see the [API documentation](https://itz.am).

itzam-1.0.0/itzam.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+README.md
+pyproject.toml
+itzam/__init__.py
+itzam.egg-info/PKG-INFO
+itzam.egg-info/SOURCES.txt
+itzam.egg-info/dependency_links.txt
+itzam.egg-info/requires.txt
+itzam.egg-info/top_level.txt
+itzam/base/__init__.py
+itzam/base/client.py
+itzam/models/__init__.py
+itzam/models/__main__.py
+itzam/models/client.py
+itzam/models/models.py
+itzam/runs/__init__.py
+itzam/runs/client.py
+itzam/runs/models.py
+itzam/text/__init__.py
+itzam/text/client.py
+itzam/text/models.py
+itzam/threads/__init__.py
+itzam/threads/client.py
+itzam/threads/models.py
+itzam/utils/exceptions.py

itzam-1.0.0/itzam.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

itzam-1.0.0/itzam.egg-info/requires.txt

@@ -0,0 +1,3 @@
+pydantic
+requests
+rich

itzam-1.0.0/itzam.egg-info/top_level.txt

@@ -0,0 +1 @@
+itzam

itzam-1.0.0/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "itzam"
+version = "1.0.0"
+description = "Python SDK to interact with Itzam's API"
+readme = "README.md"
+requires-python = ">=3.10,<4.0"
+authors = [{ name = "Joaquim Cassano", email = "joaquim@cassano.com.br" }]
+dependencies = [
+   "pydantic",
+  "requests",
+  "rich"
+]

itzam-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+