mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
Eliminates the dual-package architecture that was the root cause of #355. `pip install headroom-ai` now produces ONE wheel containing both the Python source (headroom/*.py) and the compiled Rust extension (headroom/_core.so). No more separate `headroom-core-py` package, no more chicken-and-egg with PyPI publication, no more wheelhouse / PIP_FIND_LINKS / composite-action plumbing in CI. This is the canonical pattern used by cryptography, polars, ruff, pydantic-core, and other Rust-as-core Python packages. Honors the "Rust as core engine" direction. ## What changed - pyproject.toml: `[build-system]` swapped from hatchling to maturin. `[tool.hatch.*]` deleted; `[tool.maturin]` added pointing at `crates/headroom-py/Cargo.toml` for the cdylib. `python-source = "."` picks up the root `headroom/` package directly (dashboard HTML templates and other non-Python files included automatically). - crates/headroom-py/pyproject.toml: deleted. The crate is no longer a separate published package; its Cargo.toml stays as the cdylib build target invoked via `[tool.maturin] manifest-path`. - crates/headroom-py/python/: deleted (placeholder layout for the old separate package). ## CI updates - ci.yml: `test` / `test-extras` / `test-agno` jobs simplified — Rust toolchain set up before `pip install -e .` (which now invokes maturin via build-system). Removed the "build wheel + symlink .so" dance. `build` job swapped from `python -m build` (hatch) to `maturin build` + `maturin sdist`. - release.yml: collapsed dual-package matrix into one. New `build-wheels` matrix produces cross-platform wheels for cp310/11/12/13 × {linux x86_64, linux aarch64, macos x86_64, macos aarch64}. New `collect-dist` aggregator merges artifacts. publish-pypi consumes the merged dist. - init-native-e2e.yml: dropped windows-latest from the matrix — upstream `esaxx-rs` (/MT) and `ort-sys` (/MD) link with conflicting MSVC C runtime libraries, so the Rust extension cannot build for win_amd64 today. Tracked as a follow-up; not a blocker for Linux+macOS. - headroom-e2e-setup: composite action now sets up Rust toolchain + Swatinem/rust-cache before `pip install -e .[proxy]`. - eval.yml, publish.yml, rust.yml: same pattern — rust toolchain before install. rust.yml's wheels job builds from root pyproject.toml (no more `-m crates/headroom-py/Cargo.toml`). - e2e/init/Dockerfile, e2e/wrap/Dockerfile: install rust + maturin in the build stage; copy `crates/` + workspace `Cargo.toml/lock` so the install can build the extension. Dropped `HEADROOM_REQUIRE_RUST_CORE=false` from wrap-e2e — the image now ships the full Rust core. - Dockerfile (main): simplified — no more Layer 2/3 dance with `headroom-core-py` install + symlink. Single `uv pip install` builds + installs everything. - .devcontainer/Dockerfile: rust toolchain + libssl-dev + maturin added so `uv sync` builds the extension inside the devcontainer. ## Lockfile + script - uv.lock: regenerated. No `headroom-core-py` entries remain. - scripts/build_rust_extension.sh: simplified from a symlink-into-tree workaround to a thin wrapper around `pip install -e .`. The maturin build-backend handles placement automatically. ## Local validation (all green on macOS aarch64) 1. Clean venv `pip install -e .` → `from headroom._core import …` works. 2. `maturin build --release` → 13.8 MB wheel, 336 files including `headroom/_core.cpython-311-darwin.so` (32 MB cdylib) and `headroom/dashboard/templates/dashboard.html`. 3. `pip install <wheel>` in fresh venv → import works. 4. Wheel contents verified via `unzip -l`. 5. `pytest tests/test_transforms/test_diff_compressor.py` — 29 passed. 6. `pytest tests/test_relevance.py` — 30 passed. 7. `cargo build --workspace` + `cargo test --workspace` — all green. 8. `make ci-precheck` — 176 Python tests + Rust + commitlint green. ## Migration notes Users on `pip install headroom-ai` get the Rust core automatically (linux + macos wheels). sdist installs require rust toolchain available locally — pip will build via maturin. Closes #355 Supersedes #357 (workarounds-based fix abandoned in favor of architectural fix)
347 lines
10 KiB
TOML
347 lines
10 KiB
TOML
[build-system]
|
|
requires = ["maturin>=1.5,<2.0"]
|
|
build-backend = "maturin"
|
|
|
|
[project]
|
|
name = "headroom-ai"
|
|
version = "0.9.1"
|
|
description = "The Context Optimization Layer for LLM Applications - Cut costs by 50-90%"
|
|
readme = "README.md"
|
|
license = "Apache-2.0"
|
|
requires-python = ">=3.10"
|
|
authors = [
|
|
{ name = "Headroom Contributors" }
|
|
]
|
|
maintainers = [
|
|
{ name = "Headroom Contributors" }
|
|
]
|
|
keywords = [
|
|
"llm",
|
|
"openai",
|
|
"anthropic",
|
|
"claude",
|
|
"gpt",
|
|
"context",
|
|
"token",
|
|
"optimization",
|
|
"compression",
|
|
"caching",
|
|
"proxy",
|
|
"ai",
|
|
"machine-learning",
|
|
]
|
|
classifiers = [
|
|
"Development Status :: 4 - Beta",
|
|
"Intended Audience :: Developers",
|
|
"License :: OSI Approved :: Apache Software License",
|
|
"Operating System :: OS Independent",
|
|
"Programming Language :: Python :: 3",
|
|
"Programming Language :: Python :: 3.10",
|
|
"Programming Language :: Python :: 3.11",
|
|
"Programming Language :: Python :: 3.12",
|
|
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
"Typing :: Typed",
|
|
]
|
|
dependencies = [
|
|
# Core: lightweight compression (SmartCrusher, ContentRouter, CCR, TOIN)
|
|
"tiktoken>=0.5.0", # Tokenizer for all compressors
|
|
"pydantic>=2.0.0", # Config and data models
|
|
"litellm==1.82.3", # Model registry, pricing, and provider support
|
|
"click>=8.1.0", # CLI framework
|
|
"rich>=13.0.0", # Rich terminal output
|
|
"opentelemetry-api>=1.24.0", # Safe no-op OTEL API for instrumentation
|
|
"ast-grep-cli>=0.30.0", # AST-aware code slicing (CodeCompressor); binary wheel
|
|
"tomli>=2.0.0; python_version < '3.11'", # tomllib backport for helper scripts
|
|
]
|
|
|
|
[project.optional-dependencies]
|
|
# Proxy server (most common install: pip install headroom-ai[proxy])
|
|
proxy = [
|
|
"fastapi>=0.100.0",
|
|
"uvicorn>=0.23.0",
|
|
"httpx[http2]>=0.24.0",
|
|
"openai>=2.14.0", # OpenAI API format support
|
|
"mcp>=1.0.0", # MCP server (headroom_compress, retrieve, stats)
|
|
"magika>=0.6.0", # ML content detection for ContentRouter
|
|
"zstandard>=0.20.0", # Decompress zstd request bodies (Codex, etc.)
|
|
"websockets>=13.0", # WebSocket proxy for /v1/responses (Codex gpt-5.4+)
|
|
"onnxruntime>=1.16.0", # Kompress ONNX INT8 text compression (no torch needed)
|
|
"transformers>=4.30.0", # Tokenizer only (for Kompress)
|
|
"watchdog>=4.0.0", # File watcher for live code graph reindexing (--code-graph)
|
|
"sqlite-vec>=0.1.6", # Vector index for memory (--memory). Lightweight, no torch.
|
|
]
|
|
# AST-based code compression (tree-sitter)
|
|
code = [
|
|
"tree-sitter-language-pack>=0.10.0",
|
|
]
|
|
# ML-based compression with Kompress (ModernBERT)
|
|
ml = [
|
|
"torch>=2.0.0",
|
|
"transformers>=4.30.0",
|
|
]
|
|
# Legacy ML compression (LLMLingua-2 — use [ml] instead for Kompress)
|
|
llmlingua = [
|
|
"llmlingua>=0.2.0",
|
|
"torch>=2.0.0",
|
|
"transformers>=4.30.0",
|
|
]
|
|
# Memory system (hierarchical memory with vector search)
|
|
memory = [
|
|
"hnswlib>=0.8.0",
|
|
"sqlite-vec>=0.1.6",
|
|
"sentence-transformers>=2.2.0",
|
|
]
|
|
# Qdrant + Neo4j memory backend helpers
|
|
memory-stack = [
|
|
"mem0ai>=0.1.100",
|
|
"qdrant-client>=1.9.0",
|
|
"neo4j>=5.20.0",
|
|
]
|
|
# Semantic relevance scoring with embeddings.
|
|
# Uses `fastembed` (BAAI/bge-small-en-v1.5 by default — 33M params,
|
|
# 384 dims, ~30 MB int8-quantized ONNX). Same library + model used by
|
|
# the Rust SmartCrusher (`fastembed` crate), giving byte-equal embeddings
|
|
# across the language boundary. Replaced sentence-transformers in
|
|
# Stage 3c.1 — fastembed is faster (~2-3x), smaller (no torch
|
|
# dependency), and outranks all-MiniLM-L6-v2 on MTEB by ~6 points.
|
|
relevance = [
|
|
"fastembed>=0.4.0",
|
|
"numpy>=1.24.0",
|
|
]
|
|
# Image compression (ML-based routing + OCR)
|
|
image = [
|
|
"pillow>=10.0.0",
|
|
"sentencepiece>=0.1.99", # Required by SigLIP tokenizer (SiglipTokenizer)
|
|
"rapidocr-onnxruntime>=1.4.0", # ONNX-native OCR for text extraction from images (~15MB models)
|
|
]
|
|
# Report generation
|
|
reports = [
|
|
"jinja2>=3.0.0",
|
|
]
|
|
# OpenTelemetry metrics export
|
|
otel = [
|
|
"opentelemetry-sdk>=1.24.0",
|
|
"opentelemetry-exporter-otlp-proto-http>=1.24.0",
|
|
]
|
|
# any-llm multi-provider backend (requires Python 3.11+)
|
|
anyllm = [
|
|
"any-llm-sdk>=1.0.0; python_version >= '3.11'",
|
|
]
|
|
# LangChain integration
|
|
langchain = [
|
|
"langchain-core>=0.2.0",
|
|
"langchain-openai>=0.1.0",
|
|
]
|
|
# Agno agent framework integration
|
|
agno = [
|
|
"agno>=1.0.0",
|
|
]
|
|
# AWS Strands Agents SDK integration
|
|
strands = [
|
|
"strands-agents>=0.1.0",
|
|
]
|
|
# MCP server for Claude Code integration
|
|
mcp = [
|
|
"mcp>=1.0.0",
|
|
"httpx>=0.24.0",
|
|
]
|
|
# Voice filler detection
|
|
voice = [
|
|
"onnxruntime>=1.16.0",
|
|
"transformers>=4.30.0",
|
|
"torch>=2.0.0",
|
|
]
|
|
# Voice training (includes voice deps + training extras)
|
|
voice-train = [
|
|
"headroom-ai[voice]",
|
|
"datasets>=2.14.0",
|
|
"accelerate>=0.20.0",
|
|
]
|
|
# Evaluation framework
|
|
evals = [
|
|
"datasets>=2.14.0",
|
|
"sentence-transformers>=2.2.0",
|
|
"numpy>=1.24.0",
|
|
"scikit-learn>=1.3.0",
|
|
"anthropic>=0.18.0",
|
|
"openai>=1.0.0",
|
|
]
|
|
# AWS Bedrock backend
|
|
bedrock = [
|
|
"boto3>=1.28.0",
|
|
]
|
|
# HTML content extraction
|
|
html = [
|
|
"trafilatura>=1.6.0",
|
|
]
|
|
# Comprehensive LLM benchmarks
|
|
benchmark = [
|
|
"lm-eval>=0.4.0",
|
|
"openai>=1.0.0",
|
|
"anthropic>=0.18.0",
|
|
]
|
|
# Development dependencies
|
|
dev = [
|
|
"pytest>=7.0.0",
|
|
"pytest-cov>=4.0.0",
|
|
"pytest-asyncio>=0.21.0",
|
|
"ruff>=0.1.0",
|
|
"mypy>=1.0.0",
|
|
"pre-commit>=3.0.0",
|
|
"openai>=1.0.0",
|
|
"anthropic>=0.18.0",
|
|
"litellm==1.82.3",
|
|
"fastapi>=0.100.0",
|
|
"uvicorn>=0.23.0",
|
|
"httpx[http2]>=0.24.0",
|
|
"websockets>=13.0",
|
|
"opentelemetry-sdk>=1.24.0",
|
|
"opentelemetry-exporter-otlp-proto-http>=1.24.0",
|
|
"ollama>=0.4.0",
|
|
"langchain-ollama>=0.2.0",
|
|
"hnswlib>=0.8.0",
|
|
"sqlite-vec>=0.1.6",
|
|
"sentence-transformers>=2.2.0",
|
|
"numpy>=1.24.0",
|
|
]
|
|
# All optional dependencies (everything you need)
|
|
all = [
|
|
"headroom-ai[proxy,code,ml,memory,relevance,image,reports,otel,evals,voice,html,benchmark,mcp]",
|
|
]
|
|
|
|
[project.scripts]
|
|
headroom = "headroom.cli:main"
|
|
|
|
[project.urls]
|
|
Homepage = "https://github.com/chopratejas/headroom"
|
|
Documentation = "https://github.com/chopratejas/headroom#readme"
|
|
Repository = "https://github.com/chopratejas/headroom"
|
|
Issues = "https://github.com/chopratejas/headroom/issues"
|
|
Changelog = "https://github.com/chopratejas/headroom/blob/main/CHANGELOG.md"
|
|
|
|
# Maturin builds a single wheel containing both the Python source under
|
|
# `headroom/` AND the compiled Rust extension `headroom/_core.so` (cdylib
|
|
# from `crates/headroom-py`). One `pip install headroom-ai` ships everything
|
|
# atomically — no separate `headroom-core-py` package, no chicken-and-egg,
|
|
# no PIP_FIND_LINKS plumbing. Phase A0's runtime fail-loud check still
|
|
# exists but only fires if someone forces an sdist install on a platform
|
|
# without a wheel and the rust toolchain isn't available to compile it.
|
|
[tool.maturin]
|
|
# Where the Python package lives. With `python-source = "."` and the
|
|
# package directory `headroom/` at repo root, maturin includes every file
|
|
# under `headroom/` in the wheel — that picks up the dashboard HTML
|
|
# templates, the bundled YAML configs, etc., without needing an explicit
|
|
# `include` list.
|
|
python-source = "."
|
|
module-name = "headroom._core"
|
|
# The cdylib source lives under `crates/headroom-py`. Maturin invokes
|
|
# `cargo build` with this manifest to produce `_core.cdylib`, then injects
|
|
# the resulting `.so` into the wheel at `headroom/_core.so`.
|
|
manifest-path = "crates/headroom-py/Cargo.toml"
|
|
features = ["extension-module"]
|
|
# Forbid building without the cdylib feature — bare `cargo build` won't
|
|
# produce a usable Python extension. Maturin's default `bindings` is "pyo3"
|
|
# which is correct here (see `crates/headroom-py/src/`).
|
|
bindings = "pyo3"
|
|
|
|
[tool.ruff]
|
|
target-version = "py310"
|
|
line-length = 100
|
|
|
|
[tool.ruff.lint]
|
|
select = [
|
|
"E", # pycodestyle errors
|
|
"W", # pycodestyle warnings
|
|
"F", # pyflakes
|
|
"I", # isort
|
|
"B", # flake8-bugbear
|
|
"C4", # flake8-comprehensions
|
|
"UP", # pyupgrade
|
|
]
|
|
ignore = [
|
|
"E501", # line too long (handled by formatter)
|
|
"B008", # do not perform function calls in argument defaults
|
|
"B905", # zip without strict parameter
|
|
]
|
|
|
|
[tool.ruff.lint.isort]
|
|
known-first-party = ["headroom"]
|
|
|
|
[tool.ruff.format]
|
|
quote-style = "double"
|
|
indent-style = "space"
|
|
|
|
[tool.mypy]
|
|
python_version = "3.10"
|
|
warn_return_any = true
|
|
warn_unused_configs = true
|
|
disallow_untyped_defs = true
|
|
ignore_missing_imports = true
|
|
|
|
# Per-module overrides for modules with dynamic typing patterns
|
|
[[tool.mypy.overrides]]
|
|
module = [
|
|
"headroom.proxy.server",
|
|
"headroom.proxy.cost",
|
|
"headroom.proxy.prometheus_metrics",
|
|
"headroom.proxy.semantic_cache",
|
|
"headroom.proxy.rate_limiter",
|
|
"headroom.proxy.request_logger",
|
|
"headroom.proxy.helpers",
|
|
"headroom.integrations.langchain",
|
|
"headroom.integrations.mcp",
|
|
"headroom.ccr.mcp_server",
|
|
"headroom.relevance.embedding",
|
|
"headroom.reporting.generator",
|
|
]
|
|
disallow_untyped_defs = false
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = [
|
|
"headroom.tokenizers.*",
|
|
"headroom.providers.litellm",
|
|
"headroom.providers.google",
|
|
]
|
|
disallow_untyped_defs = false
|
|
warn_return_any = false
|
|
|
|
# Handler mixins use self.* from HeadroomProxy via duck typing — mypy can't resolve these
|
|
[[tool.mypy.overrides]]
|
|
module = ["headroom.proxy.handlers.*"]
|
|
disallow_untyped_defs = false
|
|
ignore_errors = true
|
|
|
|
# Ignore third-party stubs with syntax errors
|
|
[[tool.mypy.overrides]]
|
|
module = ["mlx.*"]
|
|
ignore_errors = true
|
|
|
|
[tool.pytest.ini_options]
|
|
testpaths = ["tests"]
|
|
python_files = ["test_*.py"]
|
|
python_functions = ["test_*"]
|
|
addopts = "-v --tb=short"
|
|
asyncio_mode = "auto"
|
|
markers = [
|
|
"slow: slow tests (model loads, large fixtures)",
|
|
"real_llm: tests that hit real LLM APIs; skipped unless explicitly enabled",
|
|
"live: opt-in multi-turn tests that hit real upstream APIs; require provider keys",
|
|
]
|
|
|
|
[tool.coverage.run]
|
|
source = ["headroom"]
|
|
branch = true
|
|
omit = [
|
|
"headroom/cli.py",
|
|
"*/tests/*",
|
|
]
|
|
|
|
[tool.coverage.report]
|
|
exclude_lines = [
|
|
"pragma: no cover",
|
|
"def __repr__",
|
|
"raise NotImplementedError",
|
|
"if TYPE_CHECKING:",
|
|
"if __name__ == .__main__.:",
|
|
]
|