You can install the HUD SDK using pip:

# Install the latest stable release
pip install hud-python

# Install the latest release (may include breaking changes)
pip install --pre hud-python

​
Requirements

  • Python 3.9 or higher

  • An API key from HUD (contact us)

​
Environment Setup

The SDK uses environment variables for configuration. You can set these in your environment or in a .env file in your project root. You may need to add API keys for your own agent as well.

# .env file
HUD_API_KEY=your-api-key-here

​
Development Installation

If you want to contribute to the SDK or install it in development mode:

# Clone the repository
git clone https://github.com/humanuniondata/hud-python.git
cd hud-python

# Create a virtual environment (using venv)
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Or using uv (recommended)
uv venv
# Activate according to your shell

# Install in development mode
pip install -e ".[dev]"

​
Verification

To verify your installation, you can try running a simple example:

import hud

# Print the version number
print(f"HUD SDK version: {hud.__version__}")

You should see the version number of the installed SDK without any errors.