Requirements
- Python 3.10 or higher
- pip, poetry, or uv package manager
Install the SDK
The SDK includes all framework integrations (CrewAI, LangChain, AutoGen) by default:
pip install arzule-ingest
Configuration
Environment variables
Set your Arzule credentials as environment variables:
export ARZULE_API_KEY="your-api-key"
export ARZULE_TENANT_ID="your-tenant-id"
export ARZULE_PROJECT_ID="your-project-id"
You can find your credentials in the Arzule dashboard under Settings > API Keys. Programmatic configuration
You can also pass credentials directly to init():
import arzule_ingest
arzule_ingest.init(
api_key="your-api-key",
tenant_id="your-tenant-id",
project_id="your-project-id",
)
Avoid hardcoding credentials in source code. Use environment variables or a secrets manager in production.
Verify installation
Test that the SDK is installed correctly:
import arzule_ingest
# Should print the version number
print(arzule_ingest.__version__)
What’s included
The SDK includes support for all major agent frameworks out of the box:
- CrewAI - Automatic instrumentation for CrewAI agents
- LangChain / LangGraph - Callback-based tracing for chains and agents
- AutoGen - Automatic instrumentation for Microsoft AutoGen
- SOC2 compliance - Encryption at rest for trace files
Next steps
