Metadata-Version: 2.4
Name: contextF
Version: 0.0.6
Summary: Efficient context builder
Home-page: https://github.com/adc77/contextF.git
Author: axondendrite
Author-email: amandogra2016@gmail.com
Project-URL: Bug Reports, https://github.com/adc77/contextF/issues
Project-URL: Source, https://github.com/adc77/contextF
Project-URL: Documentation, https://github.com/adc77/contextF/blob/main/README.md
Keywords: context,documents,search,nlp,ai,text-processing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: openai
Requires-Dist: tiktoken
Requires-Dist: langchain-text-splitters
Requires-Dist: python-dotenv
Provides-Extra: pdf
Requires-Dist: pymupdf4llm; extra == "pdf"
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: flake8>=5.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# contextF

Efficient context builder. Build relevant context from documents using configurable search patterns and token-aware windowing.

## Installation

```bash
pip install contextF
```

For PDF parsing:
```bash
pip install contextF[pdf]
```

## Parameters

### Search Parameters
- `docs_path`: Directory containing documents (default: "./docs")
- `file_patterns`: File types to search (default: ["*.md", "*.txt"])
- `max_patterns_per_query`: Max search patterns to use (default: 3)
- `max_matches_per_file`: Max matches per file (default: 3)
- `case_sensitive`: Case sensitive search (default: false)

### Token Parameters
- `max_context_tokens`: Maximum total context tokens (default: 500000)
- `context_window_tokens`: Context window size around matches (default: 10000)
- `max_file_tokens`: Max tokens per file before windowing (default: 200000)
- `encoding`: Tokenizer encoding (default: "cl100k_base")

### LLM Parameters (Optional)
- `enabled`: Enable LLM pattern generation (default: true)
- `model`: OpenAI model (default: "gpt-4.1-mini")
- `temperature`: LLM temperature (default: 0.3)

## Documentation
For detailed documentation and code examples, please refer to the [README.md](https://github.com/adc77/contextF/blob/main/README.md) file.
