Skip to content

Commit c2c9b78

Browse files
committed
feat: Revise documentation and examples for version 2.0.0
- Update QUICKSTART.md and README.md to reflect the new package name `costkatana` and simplify installation instructions. - Enhance usage examples to demonstrate the new zero-configuration API and common patterns for AI interactions. - Remove outdated examples and consolidate advanced features into a more streamlined format. - Update setup.py to reflect the new package name and version 2.0.0. - Improve clarity and consistency across all documentation regarding API key management and usage.
1 parent c8faa50 commit c2c9b78

15 files changed

+1284
-2715
lines changed

CHANGELOG.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Changelog
2+
3+
All notable changes to Cost Katana Python SDK will be documented in this file.
4+
5+
## [2.0.0] - 2025-01-XX
6+
7+
### 🚀 Major Release: Complete Simplification
8+
9+
Complete redesign to make using AI in Python as simple as possible.
10+
11+
### ✨ New Features
12+
13+
#### Ultra-Simple API
14+
15+
**New `ai()` function** - The easiest way to use AI:
16+
```python
17+
import cost_katana as ck
18+
response = ck.ai('gpt-4', 'Hello')
19+
print(response.text)
20+
print(f"Cost: ${response.cost}")
21+
```
22+
23+
**New `chat()` function** - Simple chat sessions:
24+
```python
25+
import cost_katana as ck
26+
session = ck.chat('gpt-4')
27+
session.send('Hello')
28+
session.send('How are you?')
29+
print(f"Total: ${session.total_cost}")
30+
```
31+
32+
#### Auto-Configuration
33+
- Automatically detects API keys from environment
34+
- Works with `COST_KATANA_KEY` or provider keys directly
35+
- Zero setup if environment is configured
36+
- Smart error messages with actionable steps
37+
38+
#### SimpleResponse Object
39+
- Clean, simple response object
40+
- Direct access to `text`, `cost`, `tokens`
41+
- Bonus fields: `cached`, `optimized`, `provider`
42+
43+
### 💥 Breaking Changes
44+
45+
None! The traditional API (`GenerativeModel`) still works for backward compatibility.
46+
47+
**You can still use**:
48+
```python
49+
model = ck.GenerativeModel('gpt-4')
50+
response = model.generate_content('Hello')
51+
```
52+
53+
**Or use the new simple API**:
54+
```python
55+
response = ck.ai('gpt-4', 'Hello')
56+
```
57+
58+
### 📚 Documentation
59+
60+
- **Completely rewritten README**: Focus on simplicity
61+
- **Updated QUICKSTART**: 3-step process
62+
- **New examples**: Real-world use cases with simple API
63+
- **Migration guides**: From OpenAI, Anthropic, Google SDKs
64+
65+
### 🎯 Comparison
66+
67+
#### Before (v1.x)
68+
```python
69+
import cost_katana as ck
70+
71+
ck.configure(api_key='dak_...')
72+
model = ck.GenerativeModel('gpt-4')
73+
response = model.generate_content('Hello')
74+
print(response.text)
75+
```
76+
77+
#### After (v2.0)
78+
```python
79+
import cost_katana as ck
80+
81+
response = ck.ai('gpt-4', 'Hello')
82+
print(response.text)
83+
```
84+
85+
### 📦 Examples
86+
87+
New streamlined examples:
88+
- `simple_examples.py` - All basic patterns
89+
- `basic_usage.py` - Getting started
90+
- Updated all existing examples to show both APIs
91+
92+
### 🐛 Bug Fixes
93+
94+
- Improved error messages
95+
- Better environment variable detection
96+
- More robust provider inference
97+
98+
---
99+
100+
## [1.0.0] - 2024-XX-XX
101+
102+
### Initial Release
103+
- Multi-provider support
104+
- Cost tracking
105+
- Unified API
106+
- Configuration management

0 commit comments

Comments
 (0)