Skip to main content

A Python utils SDK for xpander.ai services.

Project description

xpander_utils Package Development Guide

Overview

xpander_utils is a Python utilities SDK for xpander.ai services.
It provides adapters, helpers, and utilities to integrate and enhance the development of AI agents, workflows, and more.


Installation

Install from PyPI

To use the xpander_utils package in your project, install it via pip:

pip install xpander-utils

Install Locally (Development Mode)

If you want to contribute or modify the package, clone the repository and install it locally in editable mode:

pip install -e .

This allows you to make changes to the source code without reinstalling the package after each modification.


Usage Example

Here's a simple example using SmolAgentsAdapter to bridge between xpander.ai and smolagents:

from smolagents import OpenAIServerModel, ToolCallingAgent
from xpander_utils.sdk.adapters import SmolAgentsAdapter

# API keys
llm_api_key = "{YOUR_LLM_KEY}"
xpander_api_key = "{YOUR_API_KEY}"

# Initialize Xpander agent
xpander = SmolAgentsAdapter(agent_id="{YOUR_AGENT_ID}", api_key=xpander_api_key)

# Initialize model
model = OpenAIServerModel(
    model_id="gpt-4o",
    api_key=llm_api_key
)

# Add a task to Xpander 
prompt = "get the longest tag"
xpander.add_task(input=prompt)

# Build the agent using Xpander's tools
agent = ToolCallingAgent(
    step_callbacks=[xpander.step_callback()],
    tools=xpander.get_tools(),
    model=model,
    prompt_templates={"system_prompt": xpander.get_system_prompt()}
)

# Initialize memory from Xpander
xpander.init_memory(agent=agent)

# Run the agent
result = agent.run(task=prompt, reset=False)

Dependencies

The package requires the following libraries:

  • pydantic
  • loguru
  • xpander-sdk
  • httpx
  • httpx_sse

Optional / Extras

Additional functionality can be installed with extras:

Extra Libraries Installed
smolagents smolagents
llama-index llama_index
chainlit chainlit

Example to install with extras:

pip install "xpander-utils[smolagents]"

You can combine extras:

pip install "xpander-utils[smolagents,llama-index]"

Supported Python Versions

This package officially supports Python >= 3.12.7.

Ensure you are using a compatible Python version for full functionality.


License

This project is licensed under the MIT License.


Development Notes

  • Source code is located under the src/ directory.
  • Package discovery is handled via find_packages(where="src").
  • long_description for the package is directly pulled from README.md.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xpander_utils-0.0.108.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xpander_utils-0.0.108-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file xpander_utils-0.0.108.tar.gz.

File metadata

  • Download URL: xpander_utils-0.0.108.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for xpander_utils-0.0.108.tar.gz
Algorithm Hash digest
SHA256 cdb0a756d6d48b1f69f82ccdab08bec27b39ce1fe2ccd12bae1077a4994487b9
MD5 1325d904c1007644ba2d1d64a67a7e32
BLAKE2b-256 1b35a3f17501fa048d9cff9efaa2af3c8677ec3fafea0d25da213114ee1d6feb

See more details on using hashes here.

File details

Details for the file xpander_utils-0.0.108-py3-none-any.whl.

File metadata

File hashes

Hashes for xpander_utils-0.0.108-py3-none-any.whl
Algorithm Hash digest
SHA256 eddedc2d5f1ebfe621af8b8f4b4d3983122b4231635f9d9df60077e70d3c7f9d
MD5 8e530f50aec774193ce9ceec79ce5a33
BLAKE2b-256 cfd11146b68160c5d22fef68876d2fdaef4cd6086ee00cee8790881e941bc0ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page