Metadata-Version: 2.4
Name: ai-cost-guard-sdk
Version: 1.0.1
Summary: Python SDK for AI Cost Guard — track, analyze, and optimize your AI/LLM API costs
Author-email: crediblearena <sdk@aicostguard.com>
License-Expression: MIT
Project-URL: Homepage, https://aicostguard.com
Project-URL: Documentation, https://docs.aicostguard.com/python-sdk
Project-URL: Repository, https://github.com/aicostguard/python-sdk
Keywords: ai,llm,cost,cost-tracking,cost-monitoring,cost-optimization,openai,gpt-4,gpt-4o,chatgpt,anthropic,claude,gemini,google-ai,cohere,mistral,token,token-counting,token-tracking,api-cost,api-monitoring,llm-monitoring,llm-ops,mlops,ai-ops,budget,budget-alerts,analytics,observability,ai-observability,optimization,usage-tracking,billing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: System :: Monitoring
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.28.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
Requires-Dist: responses>=0.23; extra == "dev"

# AI Cost Guard — Python SDK

> Track, analyze, and optimize your AI/LLM API costs with a single line of code. Supports **50+ models** from OpenAI, Anthropic, Google Gemini, Cohere, Mistral, and more.

[![PyPI version](https://img.shields.io/pypi/v/ai-cost-guard-sdk?color=blue)](https://pypi.org/project/ai-cost-guard-sdk/)
[![Python](https://img.shields.io/pypi/pyversions/ai-cost-guard-sdk)](https://pypi.org/project/ai-cost-guard-sdk/)
[![Downloads](https://img.shields.io/pypi/dm/ai-cost-guard-sdk)](https://pypi.org/project/ai-cost-guard-sdk/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Why AI Cost Guard?

| Problem | Solution |
|---------|----------|
| 💸 Surprise AI bills at month end | Real-time cost tracking with budget alerts |
| 🔍 Can't tell which features cost most | Per-feature & per-user cost breakdowns |
| 📊 No visibility into token usage | Automatic token counting & analytics |
| 🤝 Works only with one provider | Universal support for OpenAI, Anthropic, Gemini, Cohere, Mistral |

## Installation

```bash
pip install ai-cost-guard-sdk
```

---

## Before You Start — Get Your Free API Key

You cannot use this SDK without an API key. The key tells the server which project to save your cost data into. Getting one is free and takes less than 2 minutes.

### Step 1 — Create a Free Account

Go to **https://aicostguard.com** and click the **"Get Started"** button (top-right corner).

Fill in:
- Your name
- Your email address
- A password

Click **"Sign Up"**. You land on your dashboard automatically.

### Step 2 — Create a Project

A project is a container for one app. One project = one API key = one set of cost data in your dashboard.

1. You are now on the Dashboard: **https://aicostguard.com/dashboard**
2. Click **"Projects"** in the left sidebar
3. Click the **"New Project"** button (top-right of the page)
4. Fill in:
   - **Project Name** — e.g. `My Chatbot App`
   - **Description** — e.g. `Tracks GPT-4o costs for my support bot`
5. Click **"Create Project"**
6. Your new project card appears on the Projects page

### Step 3 — Copy Your API Key

1. On your project card, click the **"API Keys"** button
2. You will see a default API key that looks like:
   ```
   acg_live_abc123def456ghi789...
   ```
3. Click **"Copy"** to copy it to your clipboard
4. Keep it safe — treat it like a password

> 💡 **Tip:** Click **"Generate New Key"** at any time to get a fresh key.

---

## Quick Start

```python
from ai_cost_guard import AICostGuard

guard = AICostGuard(api_key="acg_live_your_key_here")

# Track any AI API call
guard.track(
    provider="openai",
    model="gpt-4",
    input_tokens=500,
    output_tokens=150,
    latency_ms=1200,
    feature="chat",
)

# Provider-specific helpers
import openai
response = openai.chat.completions.create(model="gpt-4", messages=[...])
guard.track_openai(model=response.model, usage=response.usage)

# Don't forget to flush on shutdown
guard.shutdown()
```

## Provider Helpers

### OpenAI
```python
guard.track_openai(model="gpt-4", usage=response.usage, feature="chat")
```

### Anthropic
```python
guard.track_anthropic(model="claude-3-opus", usage=response.usage, feature="analysis")
```

### Google Gemini
```python
guard.track_gemini(model="gemini-pro", usage=response.usage_metadata, feature="search")
```

### Cohere
```python
guard.track_cohere(model="command-r-plus", usage=response.meta.billed_units, feature="rag")
```

## Configuration

```python
guard = AICostGuard(
    api_key="acg_live_...",
    api_url="https://api.aicostguard.com/api/v1",  # Custom API URL
    debug=True,                    # Enable debug logging
    batch_events=True,             # Batch events (default: True)
    batch_interval_ms=5000,        # Batch flush interval (default: 5000ms)
    max_batch_size=50,             # Max events per batch (default: 50)
    max_retries=3,                 # Max retry attempts (default: 3)
    max_events_per_second=100,     # Rate limit (default: 100)
    default_feature="my-app",      # Default feature tag
)
```

## Context Manager Support

```python
from ai_cost_guard import AICostGuard

# Automatically flushes and shuts down on exit
with AICostGuard(api_key="acg_live_...") as guard:
    guard.track(provider="openai", model="gpt-4o", input_tokens=500, output_tokens=100)
```

## Async Support

```python
import asyncio
from ai_cost_guard import AsyncAICostGuard

async def main():
    guard = AsyncAICostGuard(api_key="acg_live_...")

    await guard.track(
        provider="openai",
        model="gpt-4o",
        input_tokens=1000,
        output_tokens=200,
        feature="async-chatbot",
    )

    await guard.shutdown()

asyncio.run(main())
```

## FastAPI Integration

```python
from fastapi import FastAPI
from ai_cost_guard import AICostGuard

app = FastAPI()
guard = AICostGuard(api_key="acg_live_...")

@app.post("/chat")
async def chat(prompt: str):
    import openai
    response = openai.chat.completions.create(
        model="gpt-4o",
        messages=[{"role": "user", "content": prompt}],
    )

    guard.track_openai(model=response.model, usage=response.usage, feature="chat-api")
    return {"reply": response.choices[0].message.content}

@app.on_event("shutdown")
def shutdown():
    guard.shutdown()
```

## Django Integration

```python
# settings.py
from ai_cost_guard import AICostGuard
AI_GUARD = AICostGuard(api_key="acg_live_...")

# views.py
from django.conf import settings

def chat_view(request):
    response = openai.chat.completions.create(model="gpt-4o", messages=[...])
    settings.AI_GUARD.track_openai(model=response.model, usage=response.usage, feature="django-chat")
    return JsonResponse({"reply": response.choices[0].message.content})
```

## Supported Models (50+)

| Provider | Models |
|----------|--------|
| **OpenAI** | GPT-4o, GPT-4o mini, GPT-4 Turbo, GPT-4, GPT-3.5, o3, o3-mini, o1, o1-mini |
| **Anthropic** | Claude 3.5 Sonnet, Claude 3 Opus, Claude 3 Haiku, Claude 3 Sonnet |
| **Google** | Gemini 1.5 Pro, Gemini 1.5 Flash, Gemini 1.0 Pro |
| **Cohere** | Command R+, Command R, Command, Embed |
| **Mistral** | Large, Medium, Small, Tiny |

## Ecosystem

- 📦 **[TypeScript SDK](https://www.npmjs.com/package/@crediblearena/ai-costguard)** — `npm install @crediblearena/ai-costguard`
- 🖥️ **[CLI Tool](https://www.npmjs.com/package/ai-cost-cli)** — `npx ai-cost-cli`
- 🧩 **[VS Code Extension](https://marketplace.visualstudio.com/)** — IDE integration
- 🌐 **[Chrome Extension](https://chromewebstore.google.com/)** — OpenAI cost overlay
- 📊 **[Dashboard](https://aicostguard.com)** — Full web analytics

## Links

- 🌐 [Website](https://aicostguard.com)
- 📖 [Documentation](https://aicostguard.com/docs/python-sdk)
- 💰 [Cost Calculator](https://aicostguard.com/ai-cost-calculator)
- 🐛 [Issues](https://github.com/crediblearena/ai-cost-guard/issues)

## License

MIT
