headroom-ai 0.2.2__tar.gz

headroom_ai-0.2.2/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.env.*
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.python-version
+
+# Secrets and API keys - NEVER commit these
+*.pem
+*.key
+secrets.json
+credentials.json
+.secrets
+api_keys.txt
+.anthropic
+.openai
+
+# IDE and editors
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.project
+.pydevproject
+.settings/
+*.sublime-project
+*.sublime-workspace
+.spyproject
+.spyderproject
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+
+# Thumbnails
+Icon?
+._*
+
+# Windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+# Linux
+*~
+
+# Local configuration
+local_settings.py
+*.local.py
+*.local.json
+*.local.yaml
+
+# Database files
+*.db
+*.sqlite
+*.sqlite3
+
+# Log files
+*.log
+logs/
+log/
+
+# Temporary files
+tmp/
+temp/
+*.tmp
+*.bak
+*.swp
+
+# Benchmark results (keep framework, not results)
+.benchmarks/
+benchmark_results.json
+benchmark_results/
+
+# DeepEval cache
+.deepeval/
+
+# Headroom specific
+headroom.db
+headroom_*.db
+*.jsonl
+!tests/fixtures/*.jsonl
+
+# Documentation build
+docs/_build/
+site/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Ruff
+.ruff_cache/
+
+# pyright
+pyrightconfig.json
+
+# Editor backup files
+*~
+\#*\#
+.\#*

headroom_ai-0.2.2/CHANGELOG.md

@@ -0,0 +1,129 @@
+# Changelog
+
+All notable changes to Headroom will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Production-ready proxy server with caching, rate limiting, and metrics
+- CLI command `headroom proxy` to start the proxy server
+- **LLMLingua-2 Integration** (opt-in ML-based compression)
+  - `LLMLinguaCompressor` transform using Microsoft's LLMLingua-2 model
+  - Content-aware compression rates (code: 0.4, JSON: 0.35, text: 0.3)
+  - Memory management utilities: `unload_llmlingua_model()`, `is_llmlingua_model_loaded()`
+  - Proxy integration via `--llmlingua` flag
+  - Device selection: `--llmlingua-device` (auto/cuda/cpu/mps)
+  - Custom compression rate: `--llmlingua-rate`
+  - Helpful startup hints when llmlingua is available but not enabled
+  - Install with: `pip install headroom-ai[llmlingua]`
+
+## [0.2.0] - 2025-01-07
+
+### Added
+- **SmartCrusher**: Statistical compression for tool outputs
+  - Keeps first/last K items, errors, anomalies, and relevance matches
+  - Variance-based change point detection
+  - Pattern detection (time series, logs, search results)
+- **Relevance Scoring Engine**: ML-powered item relevance
+  - `BM25Scorer`: Fast keyword matching (zero dependencies)
+  - `EmbeddingScorer`: Semantic similarity with sentence-transformers
+  - `HybridScorer`: Adaptive combination of both methods
+- **CacheAligner**: Prefix stabilization for better cache hits
+  - Dynamic date extraction
+  - Whitespace normalization
+  - Stable prefix hashing
+- **RollingWindow**: Context management within token limits
+  - Drops oldest tool units first
+  - Never orphans tool results
+  - Preserves recent turns
+- **Multi-Provider Support**:
+  - Anthropic with official `count_tokens` API
+  - Google with official `countTokens` API
+  - Cohere with official `tokenize` API
+  - Mistral with official tokenizer
+  - LiteLLM for unified interface
+- **Integrations**:
+  - LangChain callback handler (`HeadroomOptimizer`)
+  - MCP (Model Context Protocol) utilities
+- **Proxy Server** (`headroom.proxy`):
+  - Semantic caching with LRU eviction
+  - Token bucket rate limiting
+  - Retry with exponential backoff
+  - Cost tracking with budget enforcement
+  - Prometheus metrics endpoint
+  - Request logging (JSONL)
+- **Pricing Registry**: Centralized model pricing with staleness tracking
+- **Benchmarks**: Performance benchmarks for transforms and relevance scoring
+
+### Changed
+- Improved token counting accuracy across all providers
+- Enhanced tool output compression with relevance-aware selection
+
+### Fixed
+- Mistral tokenizer API compatibility
+- Google token counting for multi-turn conversations
+
+## [0.1.0] - 2025-01-05
+
+### Added
+- Initial release
+- `HeadroomClient`: OpenAI-compatible client wrapper
+- `ToolCrusher`: Basic tool output compression
+- Audit mode for observation without modification
+- Optimize mode for applying transforms
+- Simulate mode for previewing changes
+- SQLite and JSONL storage backends
+- HTML report generation
+- Streaming support
+
+### Safety Guarantees
+- Never removes human content
+- Never breaks tool ordering
+- Parse failures are no-ops
+- Preserves recency (last N turns)
+
+---
+
+## Migration Guide
+
+### From 0.1.x to 0.2.x
+
+The 0.2.0 release is backward compatible. New features are opt-in:
+
+```python
+# Old code still works
+from headroom import HeadroomClient, OpenAIProvider
+
+# New SmartCrusher (replaces ToolCrusher for better compression)
+from headroom import SmartCrusher, SmartCrusherConfig
+
+config = SmartCrusherConfig(
+    min_tokens_to_crush=200,
+    max_items_after_crush=50,
+)
+crusher = SmartCrusher(config)
+
+# New relevance scoring
+from headroom import create_scorer
+
+scorer = create_scorer("hybrid")  # or "bm25" for zero deps
+```
+
+### Using the Proxy
+
+New in 0.2.0 - run Headroom as a proxy server:
+
+```bash
+# Start the proxy
+python -m headroom.proxy.server --port 8787
+
+# Use with Claude Code
+ANTHROPIC_BASE_URL=http://localhost:8787 claude
+```
+
+[Unreleased]: https://github.com/headroom-sdk/headroom/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/headroom-sdk/headroom/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/headroom-sdk/headroom/releases/tag/v0.1.0

headroom_ai-0.2.2/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Headroom Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

headroom_ai-0.2.2/NOTICE

@@ -0,0 +1,43 @@
+Headroom
+Copyright 2025 Headroom Contributors
+
+This product includes software developed by the Headroom Contributors.
+
+Third-Party Licenses
+====================
+
+This software uses the following third-party libraries:
+
+tiktoken
+--------
+Copyright (c) 2022 OpenAI, Shantanu Jain
+Licensed under the MIT License
+https://github.com/openai/tiktoken
+
+Pydantic
+--------
+Copyright (c) 2017 to present Pydantic Services Inc. and individual contributors
+Licensed under the MIT License
+https://github.com/pydantic/pydantic
+
+sentence-transformers (optional dependency)
+-------------------------------------------
+Copyright 2019 Nils Reimers
+Licensed under the Apache License 2.0
+https://github.com/UKPLab/sentence-transformers
+
+Note: Some pretrained sentence-transformer models may have additional licensing
+restrictions based on their training data. Please verify model-specific licenses
+before commercial use.
+
+FastAPI (optional dependency)
+-----------------------------
+Copyright (c) 2018 Sebastián Ramírez
+Licensed under the MIT License
+https://github.com/tiangolo/fastapi
+
+NumPy (optional dependency)
+---------------------------
+Copyright (c) 2005-2024, NumPy Developers
+Licensed under the BSD 3-Clause License
+https://github.com/numpy/numpy