# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/adc77/contextF.git",
"name": "contextF",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "context, documents, search, nlp, ai, text-processing",
"author": "axondendrite",
"author_email": "amandogra2016@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/83/37/64a56a96d2d8b678da1eadadad559cacf32a47804c84e4f0596cbd034f3d/contextf-0.0.6.tar.gz",
"platform": null,
"description": "# contextF\n\nEfficient context builder. Build relevant context from documents using configurable search patterns and token-aware windowing.\n\n## Installation\n\n```bash\npip install contextF\n```\n\nFor PDF parsing:\n```bash\npip install contextF[pdf]\n```\n\n## Parameters\n\n### Search Parameters\n- `docs_path`: Directory containing documents (default: \"./docs\")\n- `file_patterns`: File types to search (default: [\"*.md\", \"*.txt\"])\n- `max_patterns_per_query`: Max search patterns to use (default: 3)\n- `max_matches_per_file`: Max matches per file (default: 3)\n- `case_sensitive`: Case sensitive search (default: false)\n\n### Token Parameters\n- `max_context_tokens`: Maximum total context tokens (default: 500000)\n- `context_window_tokens`: Context window size around matches (default: 10000)\n- `max_file_tokens`: Max tokens per file before windowing (default: 200000)\n- `encoding`: Tokenizer encoding (default: \"cl100k_base\")\n\n### LLM Parameters (Optional)\n- `enabled`: Enable LLM pattern generation (default: true)\n- `model`: OpenAI model (default: \"gpt-4.1-mini\")\n- `temperature`: LLM temperature (default: 0.3)\n\n## Documentation\nFor detailed documentation and code examples, please refer to the [README.md](https://github.com/adc77/contextF/blob/main/README.md) file.\n",
"bugtrack_url": null,
"license": null,
"summary": "Efficient context builder",
"version": "0.0.6",
"project_urls": {
"Bug Reports": "https://github.com/adc77/contextF/issues",
"Documentation": "https://github.com/adc77/contextF/blob/main/README.md",
"Homepage": "https://github.com/adc77/contextF.git",
"Source": "https://github.com/adc77/contextF"
},
"split_keywords": [
"context",
" documents",
" search",
" nlp",
" ai",
" text-processing"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "08e0d1c0cfd9b48082b1b95247716c8a52d1aced599d0e8d77eb5ad74072c320",
"md5": "bfa152f43f586a89e7bd6c5c4a671c1e",
"sha256": "753ae917222e2ea3702dd09722d0eddd78f9002eeb705f1ff5d3ff1bbb13fe7d"
},
"downloads": -1,
"filename": "contextf-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bfa152f43f586a89e7bd6c5c4a671c1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15994,
"upload_time": "2025-10-28T11:51:45",
"upload_time_iso_8601": "2025-10-28T11:51:45.099493Z",
"url": "https://files.pythonhosted.org/packages/08/e0/d1c0cfd9b48082b1b95247716c8a52d1aced599d0e8d77eb5ad74072c320/contextf-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "833764a56a96d2d8b678da1eadadad559cacf32a47804c84e4f0596cbd034f3d",
"md5": "06429b125f59d750a05e4cf38516d5ef",
"sha256": "8b9b2341573e25cf416e335d1c9f1cc371a2e47204ab16338abef43b413faeaf"
},
"downloads": -1,
"filename": "contextf-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "06429b125f59d750a05e4cf38516d5ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14584,
"upload_time": "2025-10-28T11:51:46",
"upload_time_iso_8601": "2025-10-28T11:51:46.336859Z",
"url": "https://files.pythonhosted.org/packages/83/37/64a56a96d2d8b678da1eadadad559cacf32a47804c84e4f0596cbd034f3d/contextf-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-28 11:51:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adc77",
"github_project": "contextF",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "contextf"
}
JSON
