fast-pruner 0.1.0__tar.gz

fast_pruner-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Cache tiktoken encoding files
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/tiktoken
+          # cl100k_base / o200k_base don't change often; bump this key if the
+          # tiktoken pin in pyproject.toml is upgraded and encodings change.
+          key: tiktoken-encodings-v1
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Check formatting (black)
+        run: black --check .
+
+      - name: Run tests
+        run: python -m pytest tests/ -v --cov=fast_pruner --cov-report=term-missing
+
+  # Placeholder for a future publish-on-tag job. Uses PyPI trusted publishing
+  # (OIDC) rather than a stored API token — wire this up once the project is
+  # ready to cut real releases.
+  # publish:
+  #   needs: test
+  #   if: startsWith(github.ref, 'refs/tags/v')
+  #   runs-on: ubuntu-latest
+  #   environment: pypi
+  #   permissions:
+  #     id-token: write
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - run: pip install build && python -m build
+  #     - uses: pypa/gh-action-pypi-publish@release/v1

fast_pruner-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,74 @@
+name: Publish
+
+# Tag naming convention:
+#   v0.1.0-rc1   -> TestPyPI (dry run / sanity check)
+#   v0.1.0       -> real PyPI (production release)
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tool
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    needs: build
+    # Only run for pre-release tags, e.g. v0.1.0-rc1
+    if: contains(github.ref_name, '-rc') || contains(github.ref_name, '-test')
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/fast-pruner
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    needs: build
+    # Only run for real release tags, e.g. v0.1.0 (not v0.1.0-rc1)
+    if: "!contains(github.ref_name, '-rc') && !contains(github.ref_name, '-test')"
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fast-pruner
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

fast_pruner-0.1.0/.gitignore

@@ -0,0 +1,32 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Packaging / build
+build/
+dist/
+*.egg-info/
+*.egg
+wheels/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+
+# Environment / secrets
+.env
+.env.*
+
+# Coverage
+.coverage
+htmlcov/

fast_pruner-0.1.0/CHANGELOG.md

@@ -0,0 +1,85 @@
+# Changelog
+
+All notable changes to this project 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/).
+
+## [Unreleased]
+
+### Fixed
+- **Critical: `import fast_pruner` failed for anyone who installed the plain
+  package** (`pip install fast-pruner`, without the `dev`/`fastapi` extras) —
+  caught via a real TestPyPI clean-install test. `fast_pruner/__init__.py`
+  unconditionally imported `FastPrunerMiddleware`, which requires `fastapi`,
+  but `fastapi` was never a core dependency. `FastPrunerMiddleware` is now a
+  lazy import (PEP 562): core imports work with zero extra dependencies, and
+  accessing `FastPrunerMiddleware` without `fastapi` installed now raises a
+  clear `ImportError` pointing to `pip install fast-pruner[fastapi]` instead
+  of failing on the bare `import fast_pruner` line.
+- New `fastapi` extra (`fastapi` + `uvicorn[standard]`) so users can install
+  just the middleware integration without pulling in `dev` tooling
+  (`pytest`, `black`, etc.). `dev` now depends on `fast-pruner[fastapi]`.
+- `uvicorn[standard]` added to `dev` extras — `examples/fastapi_server.py`
+  requires it to run and it was previously missing from
+  `pip install -e ".[dev]"`, causing a `ModuleNotFoundError` on a clean setup.
+- `ContextParser.parse_messages` no longer raises a `TypeError` on real-world
+  message payloads that include provider-specific extra fields (e.g. `tool_calls`,
+  `tool_call_id`, `function_call`). The `Message` model now allows and round-trips
+  unknown fields instead of rejecting them.
+- Assistant messages with `content: null` (common on OpenAI tool-calling turns)
+  are now coerced to an empty string instead of breaking downstream string
+  operations (tokenizing, regex-based pruning).
+- Corrected a license inconsistency: `pyproject.toml` declared MIT while the
+  `LICENSE` file and README badge are Apache 2.0. The package metadata now
+  correctly declares Apache-2.0.
+
+### Changed
+- README clarified to accurately describe the `SEMANTIC_EXTRACTIVE` strategy
+  (lexical/word-overlap cosine similarity, not embedding-based semantic
+  similarity) and the "offline" claim (the compression pipeline itself makes
+  no LLM API calls, but the default `tiktoken`-based tokenizer may need a
+  one-time network fetch to cache encoding files on first use).
+- Added a "Model & Provider Compatibility" section to the README distinguishing
+  the fully open, dependency-injected `llm_call`/`embedding_fn` callbacks (any
+  LLM or embedding model works) from `model_name` (a fixed set of recognized
+  families for token-counting purposes only, with a fallback estimate for
+  everything else). Previous wording could be read as implying the library
+  only supports a fixed list of models.
+
+### Added
+- `.gitignore` to keep build artifacts (`__pycache__/`, `*.egg-info/`) out of
+  version control.
+- `CONTRIBUTING.md` with setup, testing, and PR guidelines.
+- `embedding_fn` dependency-injection parameter for `ContextCompressor.compress()`
+  and `FastPrunerMiddleware`. When provided (signature:
+  `Callable[[List[str]], List[List[float]]]`), `SEMANTIC_EXTRACTIVE` scores
+  relevance using embedding-based cosine similarity instead of the default
+  word-overlap scorer. Batches the query and all history sentences into a
+  single call. Raises a clear `ValueError`/`RuntimeError` if the callback
+  returns a mismatched vector count or raises internally.
+- `llm_call` support added to `FastPrunerMiddleware` (previously only exposed
+  via the direct `ContextCompressor` API — the middleware silently swallowed
+  the resulting `ValueError` if `LLM_GENERATIVE` was selected without it).
+- GitHub Actions CI workflow: runs the test suite across Python 3.10–3.12,
+  enforces `black` formatting, and reports coverage. Caches `tiktoken`'s
+  encoding files to avoid re-fetching them from the remote blob store on
+  every run.
+- Codebase reformatted with `black` for consistency ahead of CI enforcement.
+
+## [0.1.0] - Initial release
+
+### Added
+- `ContextParser`: splits a raw chat-completion message array into system
+  prompts, structural/JSON rules, chat history, and the latest query.
+- `ContextCompressor`: three pruning strategies —
+  `EPHEMERAL_DROP` (chronological truncation), `SEMANTIC_EXTRACTIVE`
+  (lexical relevance + factual-density filtering), and `LLM_GENERATIVE`
+  (dependency-injected abstractive summarization).
+- `LayoutOptimizer`: reassembles pruned context with system/rules at the top
+  and the latest query at the bottom to mitigate "lost in the middle" effects.
+- `LocalTokenizerFactory`: token counting across OpenAI, Anthropic (via a
+  padding heuristic), Google Gemini, and Hugging Face model families.
+- `FastPrunerMiddleware`: FastAPI middleware for applying pruning
+  transparently to inbound chat-completion requests.
+- LangChain and LlamaIndex integration examples.

fast_pruner-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to fast-pruner
+
+Thanks for your interest in improving `fast-pruner`. This project is early-stage,
+so contributions of all sizes are welcome — bug reports, docs fixes, tests, and
+new pruning strategies.
+
+## Getting started
+
+```bash
+git clone https://github.com/saurabhdorle/fast-pruner.git
+cd fast-pruner
+pip install -e ".[dev]"
+```
+
+## Running tests
+
+```bash
+python -m pytest tests/ -v
+```
+
+> Note: the default tokenizer path uses `tiktoken`, which downloads its BPE
+> encoding files from a remote blob store on first use if they aren't already
+> cached locally. If you're working in a network-restricted environment, make
+> sure `TIKTOKEN_CACHE_DIR` points at a pre-populated cache before running the
+> suite.
+
+## Before opening a pull request
+
+- Add or update tests for any behavior change, especially for `ContextParser`
+  and `ContextCompressor` — these sit on the critical path and regressions
+  there affect every downstream integration.
+- Run `black .` to keep formatting consistent.
+- Keep the README's technical claims (offline behavior, strategy descriptions,
+  performance numbers) accurate to what the code actually does. If you change
+  behavior that the README describes, update the relevant section in the same PR.
+- Prefer small, focused PRs over large ones — easier to review, easier to revert.
+
+## Reporting bugs
+
+Please include:
+- The exact input payload (or a minimal repro) that triggered the issue
+- The strategy and parameters used (`max_history_tokens`, `strategy`, `model_name`)
+- The full traceback, if there is one
+
+## Ideas for contributions
+
+- Additional tokenizer/provider support in `LocalTokenizerFactory`
+- An optional embedding-based relevance backend for semantic pruning
+  (current `SEMANTIC_EXTRACTIVE` strategy uses lexical/word-overlap scoring)
+- Benchmarks across realistic conversation lengths and domains
+- CI workflow improvements
+
+## Code of conduct
+
+Be respectful and constructive in issues and reviews. Assume good faith.

fast_pruner-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.