Metadata-Version: 2.4
Name: context-compiler-example-integrations
Version: 0.1.0
Summary: Example integrations and enforcement-point demonstrations for Context Compiler.
Project-URL: Homepage, https://github.com/rlippmann/context-compiler-example-integrations
Project-URL: Repository, https://github.com/rlippmann/context-compiler-example-integrations
Project-URL: Issues, https://github.com/rlippmann/context-compiler-example-integrations/issues
Author: Robert Lippmann
License: Apache-2.0
License-File: LICENSE
Keywords: chromadb,context-compiler,examples,fastapi,integrations,litellm,llm,mcp,ollama,open-webui
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.11
Requires-Dist: context-compiler>=0.8.3
Provides-Extra: all
Requires-Dist: chromadb; extra == 'all'
Requires-Dist: context-compiler-directive-drafter>=0.1.2; extra == 'all'
Requires-Dist: fastapi; extra == 'all'
Requires-Dist: litellm; extra == 'all'
Provides-Extra: drafter
Requires-Dist: context-compiler-directive-drafter>=0.1.2; extra == 'drafter'
Provides-Extra: fastapi
Requires-Dist: fastapi; extra == 'fastapi'
Provides-Extra: litellm
Requires-Dist: litellm; extra == 'litellm'
Provides-Extra: retrieval
Requires-Dist: chromadb; extra == 'retrieval'
Description-Content-Type: text/markdown

# Context Compiler Example Integrations for Python

These examples show how authoritative state changes application behavior at runtime.

Each example demonstrates a single enforcement point where premise and policy influence what a host allows, routes, retrieves, builds, or executes.

- The core authority contract is provided by [`context-compiler`](https://github.com/rlippmann/context-compiler).
- Directive recognition can optionally be added with [`context-compiler-directive-drafter`](https://github.com/rlippmann/context-compiler-directive-drafter).
- These examples focus on where authoritative state changes application behavior.

*Prompt reinjection* influences ***model behavior***.

*Context Compiler* influences ***runtime behavior***.

## Install options

Base installation keeps this package discovery-first:

```shell
pip install "context-compiler-example-integrations"
```

That installs the shared core dependency only:

- `context-compiler>=0.8.0`

Add extras only for the examples you want to inspect locally:

- `pip install "context-compiler-example-integrations[drafter]"` for examples that use `context-compiler-directive-drafter`
- `pip install "context-compiler-example-integrations[retrieval]"` for ChromaDB retrieval filtering examples
- `pip install "context-compiler-example-integrations[fastapi]"` for FastAPI variants
- `pip install "context-compiler-example-integrations[litellm]"` for LiteLLM-oriented examples and reference integrations
- `pip install "context-compiler-example-integrations[all]"` to install all package-managed optional dependencies

Open WebUI is not installed by this package. The Open WebUI reference
integration assumes Open WebUI is already installed and configured as the host
runtime.

## Generic examples

- [Checkpoint continuation](examples/checkpoint_continuation/README.md): persisted confirmation and resume flows change host behavior across turns or requests
- [Execution authorization](examples/execution_authorization/README.md): protected host actions execute only when authoritative state allows them
- [Gateway middleware](examples/gateway_middleware/README.md): the host allows, blocks, or routes requests before downstream work runs
- [Prompt construction](examples/prompt_construction/README.md): the host builds different request or prompt payloads from authoritative state
- [Retrieval filtering](examples/retrieval_filtering/README.md): the host changes which documents are eligible or relevant before returning results
- [Schema selection](examples/schema_selection/README.md): the host picks different workflow or response schemas from authoritative state
- [Tool gating](examples/tool_gating/README.md): the host changes which tools are visible or executable at runtime

## Reference integrations

Python also includes reference integrations for runtime-specific behavior after
the generic examples.

Open a reference integration when you want to see the same kind of runtime
behavior on a specific host or framework surface.

Start with the generic example first, then use the Python reference
integrations to inspect a runtime-specific path:

- [python/reference_integrations/litellm_proxy/README.md](reference_integrations/litellm_proxy/README.md)
- [python/reference_integrations/openwebui_pipe/README.md](reference_integrations/openwebui_pipe/README.md)

## Run an example

To explore or run an example, use a repository checkout:

1. Clone
   [`context-compiler-example-integrations`](https://github.com/rlippmann/context-compiler-example-integrations).
2. Choose a generic example or a reference integration.
3. Open that example's README.
4. Follow the example-specific setup, runtime, and validation instructions.
