omnichunk 0.1.0__tar.gz

omnichunk-0.1.0/.gitignore

@@ -0,0 +1,208 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+.DS_Store

omnichunk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oğuzhan KIR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

omnichunk-0.1.0/PKG-INFO

@@ -0,0 +1,313 @@
+Metadata-Version: 2.4
+Name: omnichunk
+Version: 0.1.0
+Summary: Structure-aware deterministic chunking for code, prose, and markup.
+Project-URL: Homepage, https://github.com/oguzhankir/omnichunk
+Project-URL: Documentation, https://github.com/oguzhankir/omnichunk#readme
+Project-URL: Issues, https://github.com/oguzhankir/omnichunk/issues
+Project-URL: Source, https://github.com/oguzhankir/omnichunk
+Project-URL: Changelog, https://github.com/oguzhankir/omnichunk/blob/main/CHANGELOG.md
+License: MIT
+License-File: LICENSE
+Keywords: chunking,code-analysis,embedding,llm,rag,semantic-search,tree-sitter
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: tree-sitter-go>=0.23.0
+Requires-Dist: tree-sitter-java>=0.23.0
+Requires-Dist: tree-sitter-javascript>=0.23.0
+Requires-Dist: tree-sitter-python>=0.23.0
+Requires-Dist: tree-sitter-rust>=0.23.0
+Requires-Dist: tree-sitter-typescript>=0.23.0
+Requires-Dist: tree-sitter>=0.23.0
+Provides-Extra: all-languages
+Requires-Dist: tree-sitter-c-sharp>=0.23.0; extra == 'all-languages'
+Requires-Dist: tree-sitter-c>=0.23.0; extra == 'all-languages'
+Requires-Dist: tree-sitter-cpp>=0.23.0; extra == 'all-languages'
+Requires-Dist: tree-sitter-kotlin>=0.23.0; extra == 'all-languages'
+Requires-Dist: tree-sitter-php>=0.23.0; extra == 'all-languages'
+Requires-Dist: tree-sitter-ruby>=0.23.0; extra == 'all-languages'
+Requires-Dist: tree-sitter-swift>=0.23.0; extra == 'all-languages'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: tiktoken>=0.5.0; extra == 'dev'
+Provides-Extra: tiktoken
+Requires-Dist: tiktoken>=0.5.0; extra == 'tiktoken'
+Provides-Extra: transformers
+Requires-Dist: transformers>=4.30.0; extra == 'transformers'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="assets/logo/omnichunk-logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="assets/logo/omnichunk-logo.svg">
+    <img src="assets/logo/omnichunk-logo.svg" alt="omnichunk" width="360">
+  </picture>
+  <br><br>
+  <p>Structure-aware chunking for code, prose, and markup.</p>
+
+  [![PyPI](https://img.shields.io/pypi/v/omnichunk)](https://pypi.org/project/omnichunk/)
+  [![CI](https://github.com/oguzhankir/omnichunk/actions/workflows/ci.yml/badge.svg)](https://github.com/oguzhankir/omnichunk/actions/workflows/ci.yml)
+  [![Python](https://img.shields.io/pypi/pyversions/omnichunk)](https://pypi.org/project/omnichunk/)
+  [![License](https://img.shields.io/pypi/l/omnichunk)](https://github.com/oguzhankir/omnichunk/blob/main/LICENSE)
+</div>
+
+# omnichunk
+
+Chunk code, prose, and markup files with structure awareness.
+
+`omnichunk` is a Python library that splits files into smaller pieces while keeping useful context:
+
+- **Code**: respects function/class boundaries, includes scope and import information
+- **Markdown**: respects headings and sections
+- **JSON/YAML/TOML**: splits by top-level keys/sections
+- **HTML/XML**: splits by elements
+- **Mixed files**: handles notebooks and Python files with long docstrings
+
+Each chunk includes:
+- The original text slice
+- Byte and line ranges for lossless reconstruction
+- Context (scope, entities, headings, imports, siblings)
+- Optional `contextualized_text` for embeddings
+
+The library is deterministic and works without external APIs.
+
+## Installation
+
+```bash
+pip install omnichunk
+```
+
+Optional extras:
+
+```bash
+pip install omnichunk[tiktoken]        # tiktoken tokenizer support
+pip install omnichunk[transformers]    # HuggingFace tokenizer support
+pip install omnichunk[all-languages]   # Extended language grammars
+pip install omnichunk[dev]             # Development tools
+```
+
+## Quick start
+
+### One-shot API
+
+```python
+from omnichunk import chunk
+
+code = """
+import os
+
+def hello(name: str) -> str:
+    return f"hello {name}"
+"""
+
+chunks = chunk("example.py", code, max_chunk_size=128, size_unit="chars")
+
+for c in chunks:
+    print(c.index, c.byte_range, c.context.breadcrumb)
+    print(c.contextualized_text)
+```
+
+### Reusable `Chunker`
+
+```python
+from omnichunk import Chunker
+
+chunker = Chunker(
+    max_chunk_size=1024,
+    min_chunk_size=80,
+    tokenizer="cl100k_base",
+    context_mode="full",
+    overlap=0.1,
+    overlap_lines=1,
+)
+
+chunks = chunker.chunk("api.py", source_code)
+
+for c in chunker.stream("large.py", large_source):
+    consume(c)
+
+batch_results = chunker.batch(
+    [
+        {"filepath": "a.py", "code": code_a},
+        {"filepath": "b.ts", "code": code_b},
+        {"filepath": "README.md", "code": readme_md},
+    ],
+    concurrency=8,
+)
+```
+
+### File API
+
+```python
+from omnichunk import chunk_file
+
+chunks = chunk_file("path/to/file.py")
+```
+
+## Chunk model
+
+Every `Chunk` includes raw content, exact offsets, and rich context:
+
+- `text`: exact source slice (lossless reconstruction)
+- `contextualized_text`: embedding-ready representation
+- `byte_range`, `line_range`
+- `context`: scope, entities, siblings, imports, headings, section metadata
+- `token_count`, `char_count`, `nws_count`
+
+## Supported content
+
+### Code
+
+- Python
+- JavaScript / TypeScript
+- Rust
+- Go
+- Java
+- C / C++ / C#
+- Ruby / PHP / Kotlin / Swift (grammar-dependent)
+
+### Prose
+
+- Markdown
+- Plaintext
+
+Markdown fenced blocks are delegated by language:
+
+- fenced code (`python`, `ts`, etc.) routes to `CodeEngine`
+- fenced markup (`json`, `yaml`, `toml`, `html`, `xml`) routes to `MarkupEngine`
+
+### Markup
+
+- JSON
+- YAML
+- TOML
+- HTML / XML
+
+### Hybrid
+
+- Python with heavy docstrings
+- Notebook-style `# %%` cell files
+
+## Architecture
+
+```
+src/omnichunk/
+├── chunker.py
+├── types.py
+├── engine/
+│   ├── router.py
+│   ├── code_engine.py
+│   ├── prose_engine.py
+│   ├── markup_engine.py
+│   └── hybrid_engine.py
+├── parser/
+│   ├── tree_sitter.py
+│   ├── markdown_parser.py
+│   ├── html_parser.py
+│   └── languages.py
+├── context/
+│   ├── entities.py
+│   ├── scope.py
+│   ├── siblings.py
+│   ├── imports.py
+│   └── format.py
+├── sizing/
+│   ├── nws.py
+│   ├── tokenizers.py
+│   └── counter.py
+└── windowing/
+    ├── greedy.py
+    ├── merge.py
+    ├── split.py
+    └── overlap.py
+```
+
+## Determinism & integrity guarantees
+
+`omnichunk` is built to preserve source fidelity:
+
+- Chunk boundaries are deterministic
+- Empty/whitespace-only chunks are dropped
+- Chunks are contiguous and non-overlapping in source order
+- Byte range integrity is validated in tests:
+
+```python
+original_bytes = source.encode("utf-8")
+for chunk in chunks:
+    assert original_bytes[chunk.byte_range.start:chunk.byte_range.end].decode("utf-8") == chunk.text
+```
+
+## Testing
+
+Run the test suite:
+
+```bash
+pytest -q
+```
+
+Run benchmark scenarios:
+
+```bash
+python benchmarks/run_benchmarks.py
+python benchmarks/run_comparisons.py
+python benchmarks/run_quality_report.py
+```
+
+Run repository checks:
+
+```bash
+python scripts/check_ai_rules_sync.py
+python scripts/check_benchmarks.py
+python scripts/check_benchmarks.py --run-quality
+```
+
+Current suite covers:
+
+- API usage (`chunk`, `chunk_file`, `Chunker`)
+- Code/prose/markup/hybrid behavior
+- Context metadata (imports, siblings, scope, headings)
+- Sizing/tokenization/NWS logic
+- Overlap behavior
+- Edge cases (empty input, unicode, malformed syntax, range contiguity)
+
+## Contributing
+
+Contribution and project process files:
+
+- `CONTRIBUTING.md`
+- `CODE_OF_CONDUCT.md`
+- `SECURITY.md`
+- `GOVERNANCE.md`
+- `MAINTAINERS.md`
+- `ROADMAP.md`
+- `ARCHITECTURE.md`
+
+Install dev tooling and run pre-commit hooks:
+
+```bash
+pip install -e .[dev]
+pre-commit install
+pre-commit run --all-files
+```
+
+## Notes
+
+- Tree-sitter grammars are resolved dynamically and cached per language.
+- If a parser is unavailable, the system degrades gracefully with fallback heuristics.
+- `contextualized_text` is optimized for embedding quality while preserving raw `text` separately.