mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
This commit prepares Headroom for public open source release with comprehensive documentation, licensing, and community infrastructure. License & Legal: - Add Apache 2.0 LICENSE file - Add NOTICE file with third-party attributions - Add SECURITY.md for vulnerability reporting Community: - Add CONTRIBUTING.md with contribution guidelines - Add CODE_OF_CONDUCT.md (Contributor Covenant) - Add GitHub issue templates (bug report, feature request) - Add pull request template Documentation: - Update README.md with compelling value proposition - Add docs/getting-started.md - Add docs/proxy.md for proxy server documentation - Add docs/transforms.md for transform reference - Add docs/api.md for API reference - Add examples/README.md Package Infrastructure: - Add headroom/py.typed for PEP 561 compliance - Add headroom/cli.py for CLI entry point - Add .github/workflows/ci.yml for CI pipeline - Add .github/workflows/publish.yml for PyPI publishing - Update pyproject.toml with proper metadata New Features: - Add multi-provider support (Google, Cohere, LiteLLM, OpenAI-compatible) - Add universal tokenizer registry with multiple backends - Add model registry with pricing and context limits - Add production proxy server with caching and rate limiting Code Quality: - Fix 83 lint issues via ruff auto-fix - Fix version consistency (benchmarks 0.1.0 → 0.2.0) - Add skip decorators for optional dependency tests
944 B
944 B
| name | about | title | labels | assignees |
|---|---|---|---|---|
| Bug Report | Report a bug to help us improve Headroom | [BUG] | bug |
Description
A clear and concise description of what the bug is.
To Reproduce
Steps to reproduce the behavior:
- Install headroom with '...'
- Run this code '...'
- See error
Expected Behavior
What you expected to happen.
Actual Behavior
What actually happened.
Code Sample
# Minimal code to reproduce the issue
from headroom import HeadroomClient
# Your code here
Error Output
Paste any error messages or stack traces here
Environment
- Headroom version: (run
python -c "import headroom; print(headroom.__version__)") - Python version: (run
python --version) - OS: (e.g., macOS 14.0, Ubuntu 22.04, Windows 11)
- LLM Provider: (e.g., OpenAI, Anthropic)
Additional Context
Add any other context about the problem here (logs, screenshots, etc.)