Getting Started
Installation
Learn how to install the HUD SDK
Install the HUD SDK using pip:
Requirements
- Python: 3.10 or higher
- API Keys:
- HUD API Key (required)
- OpenAI API Key (optional, for
OperatorAgent
) - Anthropic API Key (optional, for
ClaudeAgent
)
Environment Setup
The SDK automatically loads API keys from environment variables or a .env
file in your project root.
Create a .env
file in your project root with your keys:
Alternatively, set them as environment variables.
Development Installation
If you want to contribute to the SDK or install it in development mode:
Verification
To verify your installation and setup, try running the example code in the Quickstart Guide.