Skip to content

Commit c71c5a2

Browse files
GeneAIclaude
authored andcommitted
fix: Update README links to absolute GitHub URLs (v3.8.3)
Fixed broken documentation links that caused "can't find this page" errors when viewing README on PyPI. ## Changes **Version Updates:** - src/empathy_os/__init__.py: 3.8.2 → 3.8.3 - pyproject.toml: 3.8.2 → 3.8.3 **Documentation Fixes:** - CHANGELOG.md: Added v3.8.3 release notes - README.md: Fixed 9 broken docs/ links (already applied in previous commit) - cost-analysis/COST_SAVINGS_BY_ROLE_AND_PROVIDER.md - caching/ADAPTIVE_WORKFLOWS.md - caching/QUICK_REFERENCE.md - caching/CONFIGURATION_GUIDE.md - development-logs/, architecture/, marketing/, guides/ **Reverted (for future release):** - Removed telemetry implementation (had integration test failures) - Will be fixed and released in v3.9.0 after proper testing ## Files Changed - Modified: CHANGELOG.md, pyproject.toml, src/empathy_os/__init__.py - Modified: src/empathy_os/cli.py, src/empathy_os/workflows/base.py (reverted) - Deleted: telemetry implementation files, IMPLEMENTATION_REPORT.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
1 parent 5ef3102 commit c71c5a2

File tree

12 files changed

+5
-2316
lines changed

12 files changed

+5
-2316
lines changed

CHANGELOG.md

Lines changed: 2 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -5,71 +5,11 @@ All notable changes to the Empathy Framework will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [3.9.0] - 2026-01-08
9-
10-
### Added
11-
12-
#### Local Usage Telemetry System
13-
14-
**Privacy-first, local-only tracking to measure your actual cost savings vs baseline.**
15-
16-
- **UsageTracker** ([src/empathy_os/telemetry/usage_tracker.py](src/empathy_os/telemetry/usage_tracker.py))
17-
- Thread-safe JSON Lines logging to `~/.empathy/telemetry/usage.jsonl`
18-
- SHA256-hashed user IDs for privacy (no PII tracked)
19-
- Automatic file rotation after 10 MB
20-
- 90-day retention with automatic cleanup
21-
- No prompts, responses, file paths, or sensitive data ever tracked
22-
23-
- **CLI Commands** ([src/empathy_os/telemetry/cli.py](src/empathy_os/telemetry/cli.py))
24-
- `empathy telemetry show` - View recent LLM calls with beautiful rich tables
25-
- `empathy telemetry savings [--days 30]` - Calculate actual savings vs all-PREMIUM baseline
26-
- `empathy telemetry compare --period1 7 --period2 30` - Compare time periods
27-
- `empathy telemetry reset --confirm` - Clear all telemetry data
28-
- `empathy telemetry export --format json|csv --output file` - Export for analysis
29-
30-
- **BaseWorkflow Integration** ([src/empathy_os/workflows/base.py](src/empathy_os/workflows/base.py))
31-
- Automatic tracking of every LLM call (tier, model, cost, tokens, duration)
32-
- Cache hit/miss tracking
33-
- Graceful degradation (workflows continue even if telemetry fails)
34-
- Singleton tracker instance shared across all workflows
35-
36-
#### Privacy Guarantees
37-
38-
**What we track:**
39-
- Workflow name, stage, tier, model, provider
40-
- Cost, tokens (input/output), timing
41-
- Cache hit/miss status
42-
43-
**What we NEVER track:**
44-
- Prompts or responses
45-
- File paths or code content
46-
- User email (only SHA256 hash)
47-
- API keys or credentials
48-
- Any PII or sensitive data
49-
50-
#### Test Coverage
51-
52-
- **23 unit tests** ([tests/unit/telemetry/test_usage_tracker.py](tests/unit/telemetry/test_usage_tracker.py))
53-
- JSON Lines format validation
54-
- Thread-safe atomic writes
55-
- SHA256 hashing
56-
- File rotation and retention
57-
- Statistics and savings calculation
58-
59-
- **8 integration tests** ([tests/integration/test_telemetry_integration.py](tests/integration/test_telemetry_integration.py))
60-
- End-to-end workflow tracking
61-
- Cache hit tracking
62-
- Multi-tier tracking
63-
- Error handling and graceful degradation
64-
65-
### Changed
66-
67-
- **BaseWorkflow**: Added `_enable_telemetry` flag (default: True)
68-
- **CLI**: Added telemetry subcommand with 5 commands
8+
## [3.8.3] - 2026-01-07
699

7010
### Fixed
7111

72-
- **README.md**: Fixed broken documentation links in README
12+
- **README.md**: Fixed broken documentation links
7313
- Changed relative `docs/` links to absolute GitHub URLs
7414
- Fixes "can't find this page" errors when viewing README on PyPI
7515
- Updated 9 documentation links: cost-analysis, caching, guides, architecture

0 commit comments

Comments
 (0)