> ## Documentation Index
> Fetch the complete documentation index at: https://agent-observability-docs.splunk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Get started using the Splunk AO Python SDK

<CardGroup cols={2}>
  <Card title="Python SDK" icon="python" horizontal href="https://pypi.org/project/splunk-ao">
    The Splunk AO Python SDK on PyPI.
  </Card>

  <Card title="Python SDK GitHub repo" icon="github" horizontal href="https://github.com/splunk/splunk-ao-python">
    The GitHub repo for the Splunk AO Python SDK.
  </Card>
</CardGroup>

## Installation

<CodeGroup>
  ```bash Pip theme={null}
  pip install splunk-ao
  ```

  ```bash uv theme={null}
  uv pip install splunk-ao
  ```

  ```bash Poetry theme={null}
  poetry add splunk-ao
  ```
</CodeGroup>

<Note>
  If you are using the free version of Splunk Agent Observability, there is no need to set the `SPLUNK_AO_CONSOLE_URL` environment variable.
</Note>

If you are using the OpenAI wrapper, you need to install the optional OpenAI dependencies.

<CodeGroup>
  ```bash Pip theme={null}
  pip install "splunk-ao[openai]"
  ```

  ```bash uv theme={null}
  uv pip install "splunk-ao[openai]"
  ```

  ```bash Poetry theme={null}
  poetry add "splunk-ao[openai]"
  ```
</CodeGroup>

## Initialization/Authentication

You can configure Splunk Agent Observability using environment variables:

<CodeGroup>
  ```ini .env theme={null}
  # Provide your Splunk Agent Observability
  # API key and URL if you are using an
  # on-premises, standalone, or custom deployment
  # SPLUNK_AO_API_KEY="your-splunk-ao-api-key"
  # SPLUNK_AO_CONSOLE_URL="your-splunk-ao-url"

  # Your Splunk Agent Observability project name
  SPLUNK_AO_PROJECT="your-splunk-ao-project-name"

  # The name of the Agent Stream you want to use for logging
  SPLUNK_AO_AGENT_STREAM="your-splunk-ao-agent-stream"
  ```
</CodeGroup>

<Note>
  If you are using the free version of Splunk Agent Observability, there is no need to set the `SPLUNK_AO_CONSOLE_URL` environment variable.
</Note>