Agents Client
A comprehensive package for interacting with the Agents API, providing both a Python client library and a command-line interface (CLI).
Components
This package consists of two main components:
- agent_client: A Python client library providing a simple, OpenAI-like API for interacting with agents
- agent_client_cli: A command-line interface (CLI) for interacting with the Agents API
Installation
Basic Installation
pip install agents-client
Installation with CLI Support
pip install "agents-client[cli]"
Development Installation
pip install "agents-client[dev]"
Client Library Usage
Quick Start
from agent_client import Agent
# Initialize the agent
agent = Agent(
agent_id="your-agent-id",
api_key="your-api-key"
)
# Define a callback function for streaming responses
def handle_response(response):
print(f"Received: {response.get('type')} - {response.get('message')}")
# Start streaming responses in a background thread
agent.start_streaming(handle_response)
# Send a message to the agent
response = agent.message("Hello, Agent!")
print(f"Message sent! Response ID: {response.get('row_id')}")
# Responses will be streamed to your callback function
# When done, stop streaming
agent.stop_streaming()
Client Features
Agent Class
The Agent class provides a simple interface similar to OpenAI's API:
# Initialize with required parameters
agent = Agent(
agent_id="your-agent-id",
api_key="your-api-key",
base_url="http://localhost:6665", # Optional
stream_callback=handle_response # Optional, can be provided later
)
Sending Messages
# Send a simple text message
agent.message("Hello, agent!")
# Send a message with additional parameters
agent.message("Process this data",
priority="high",
format="json"
)
Streaming Responses
# Define a callback to handle streaming responses
def handle_response(response):
print(f"Received: {response}")
# Start streaming with the callback
agent.start_streaming(handle_response)
# Or provide the callback during initialization
agent = Agent(
agent_id="your-agent-id",
api_key="your-api-key",
stream_callback=handle_response
)
agent.start_streaming()
# When done, stop streaming
agent.stop_streaming()
File Upload
# Upload a file to the agent
with open("document.pdf", "rb") as file:
agent.upload_file("/destination/path.pdf", file)
CLI Usage
After installing with CLI support, you can use the agents-cli command:
Setup and Configuration
# Initial setup
agents-cli setup
# View or update configuration
agents-cli config
Managing Agents and API Keys
# List all your agents
agents-cli agents
# List your API keys
agents-cli api-keys
# Create a new API key
agents-cli create-key --name "My New Key"
# Show usage statistics
agents-cli usage
# Get detailed information about a specific agent
agents-cli agent-info <agent_id>
Interacting with Agents
# Send a message to an agent
agents-cli send message '{"text":"Hello"}' --api-key mykey --agent-id myagent
# Upload a file to an agent
agents-cli upload /data/file.txt ./local.txt --api-key mykey --agent-id myagent
# Connect to the WebSocket stream for an agent
agents-cli stream --api-key mykey --agent-id myagent
Examples
See the examples/ directory for complete usage examples for both the client library and CLI.
Legacy Functions
For backward compatibility, the package also provides standalone functions:
from agent_client import send_operation, upload_file
# Send an operation
send_operation("message", {"text": "Hello"}, "api-key", "agent-id")
# Upload a file
with open("file.txt", "rb") as f:
upload_file("api-key", "agent-id", "/path/to/store.txt", f)
Development and Release
The project includes a release script to automate versioning, building, and publishing to PyPI.
Release Script
The release.py script automates:
- Version incrementing in pyproject.toml
- Running tests
- Package building
- PyPI uploading
Basic Usage
# Make the script executable if needed
chmod +x release.py
# Run with default options (patch version increment)
./release.py
This will:
- Increment the patch version (e.g., 0.2.0 → 0.2.1)
- Run tests to validate the package
- Build the package
- Upload to PyPI
Command Line Options
# Show help message
./release.py --help
# Release a minor version (e.g., 0.2.0 → 0.3.0)
./release.py --level minor
# Release a major version (e.g., 0.2.0 → 1.0.0)
./release.py --level major
# Build without uploading to PyPI
./release.py --build-only
# Skip running tests (use with caution)
./release.py --skip-tests
PyPI Authentication
When uploading to PyPI, you'll be prompted for your PyPI credentials. To avoid this:
-
Create a
.pypircfile in your home directory:[pypi] username = your_username password = your_password -
Secure the file:
chmod 600 ~/.pypirc
Alternatively, use API tokens for more secure authentication.
License
Apache Software License
Metadata
Release files for agents-client 0.2.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| agents_client-0.2.9.tar.gz | 18.8 kB | Without provenance | Details for agents_client-0.2.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| agents_client-0.2.9-py3-none-any.whl | Python 3 | none | any | Details for agents_client-0.2.9-py3-none-any.whl |
Total release size: 35.7 kB
Release files / agents_client-0.2.9.tar.gz
| Download URL | agents_client-0.2.9.tar.gz |
|---|---|
| Size | 18.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11114523b95feb62a71cd8fdf53a74fe0821b4c495da780db4ef4da166db85dc
|
|
BLAKE2b-256 checksum How to use checksums |
d8ebc61906414690e57c98ca1f63a2d3cca1139ba451b1495fa9469eb31e24e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.7
|
Release files / agents_client-0.2.9-py3-none-any.whl
| Download URL | agents_client-0.2.9-py3-none-any.whl |
|---|---|
| Size | 16.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4515e99527f7173bd25fc61158bf07bb0abbede09ffe40510800381fd2d05d05
|
|
BLAKE2b-256 checksum How to use checksums |
14c616eb2660159c2596010cbddfe04c90674171072e5b56603d4a27899155b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.7
|
Security for agents-client 0.2.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.