kosha-okf 0.1.0__tar.gz

kosha_okf-0.1.0/.github/workflows/acceptance.yml

@@ -0,0 +1,38 @@
+name: Acceptance
+
+# Opt-in / manual: the acceptance gate and the per-surface eval suites may make
+# model calls when a non-local provider is env-configured, so this runs on demand
+# rather than on every push/PR (the default providers are local and offline).
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: acceptance-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  acceptance:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+
+      - name: Install Python and dependencies
+        run: uv sync --locked
+
+      - name: MVP success-criteria gate (exit 0 iff all four pass)
+        run: uv run kosha bench acceptance --report ACCEPTANCE_REPORT.md
+
+      - name: Per-surface eval suites
+        run: uv run pytest evals -q
+
+      - name: Upload acceptance report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: acceptance-report
+          path: ACCEPTANCE_REPORT.md

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

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+
+      - name: Install Python and dependencies
+        run: uv sync --locked
+
+      - name: Lint (ruff)
+        run: uv run ruff check
+
+      - name: Type-check (mypy --strict)
+        run: uv run mypy --strict src
+
+      - name: Test (pytest)
+        run: uv run pytest -q
+
+      - name: Conformance gate (kosha validate)
+        run: uv run kosha validate tests/fixtures/good_bundle

kosha_okf-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

kosha_okf-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

kosha_okf-0.1.0/ACCEPTANCE_REPORT.md

@@ -0,0 +1,48 @@
+# Kosha MVP Acceptance Report
+
+**Verdict: PASS** - the MVP success contract holds on the reference corpus.
+
+## Setup
+
+- Corpus: `bundles/northwind` (12 concepts)
+- Embedding provider: `lexical-hash-256`
+- Generation provider: `extractive-3`
+
+Token figures are deterministic (fixed corpus, fixed queries, deterministic local providers); latency is wall-clock and environment-dependent, so the latency gate falls back to the deterministic round-trip comparison below the wall-clock noise floor.
+
+## Criteria
+
+| Criterion | Result | Target |
+|---|---|---|
+| C1-token-latency Hybrid token cost < RAG (at matched quality) and latency within RAG margin | PASS | hybrid total tokens < raw-docs baseline AND hybrid tokens-per-recall < RAG; hybrid latency within 2x RAG (round-trip comparison below 5ms wall-clock) |
+| C2-duplicate-rate Duplicate-rate ~= 0 after repeated ingests | PASS | duplicate-rate <= 0.00 on a re-ingest of the corpus |
+| C3-fidelity Fidelity preserved across >=20 sequential ingests | PASS | no edit-drift across >=20 ingests |
+| C4-contradiction-safety Contradictions resolved-or-escalated, 0 silent overwrites | PASS | 100% of injected contradictions resolved-or-escalated; 0 silent overwrites |
+
+### C1-token-latency — PASS
+
+_Hybrid token cost < RAG (at matched quality) and latency within RAG margin_
+
+tokens: hybrid 602 vs RAG 541 vs raw-docs 1131; concept recall: hybrid 1.00 vs RAG 0.62; tokens-per-recall: hybrid 602 vs RAG 865 (PASS); hybrid < raw-docs PASS. latency: hybrid 2 round-trips vs RAG 2, 0.34ms vs 0.49ms (0.69x, margin 2x; wall-clock below noise floor).
+
+### C2-duplicate-rate — PASS
+
+_Duplicate-rate ~= 0 after repeated ingests_
+
+re-ingesting 12 existing concepts: 0 CREATE / 12 UPDATE; duplicate-rate 0.000.
+
+### C3-fidelity — PASS
+
+_Fidelity preserved across >=20 sequential ingests_
+
+20 sequential ingests: body==claim projection True; every in-force claim grounded True; unrelated claim byte-identical True; OKF-conformant each step True; latest statement reflected, telephone-game absent True.
+
+### C4-contradiction-safety — PASS
+
+_Contradictions resolved-or-escalated, 0 silent overwrites_
+
+12 injected contradictions: 12 detected; 11 resolved (temporal/authority) + 1 escalated = 12 handled; 0 silent overwrites.
+
+## Decision
+
+All success criteria: **PASS**. The MVP meets its measured success contract.

kosha_okf-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing
+
+Kosha is a deterministic spine with isolated, eval-gated LLM surfaces. Contributions are expected to keep that shape: code owns control flow, file I/O, conformance, and traversal; the model is touched only behind a typed provider interface with an eval suite. Read [system design §1](docs/system_design.md) before changing the architecture.
+
+## Development setup
+
+Requires Python ≥ 3.12 and [`uv`](https://docs.astral.sh/uv/).
+
+```bash
+git clone <repo-url> kosha && cd kosha
+uv sync           # runtime + dev toolchain (ruff, mypy, pytest, mcp)
+uv run kosha --version
+```
+
+Use `uv` only — never `pip`. Add dependencies with `uv add` (or `uv add --dev` for tooling).
+
+## The gate set
+
+CI runs these on every push and pull request ([`.github/workflows/ci.yml`](.github/workflows/ci.yml)). Run them locally before opening a PR — they are the contract:
+
+```bash
+uv run ruff check                              # lint
+uv run mypy --strict src                       # type-check (strict)
+uv run pytest -q                               # tests
+uv run kosha validate tests/fixtures/good_bundle   # conformance gate
+```
+
+All four must pass. The acceptance gate and per-surface eval suites run separately (and may make model calls when a non-local provider is configured), so they are opt-in via the manual `Acceptance` workflow:
+
+```bash
+uv run kosha bench acceptance --report ACCEPTANCE_REPORT.md
+uv run pytest evals -q
+```
+
+## Code style
+
+Enforced by `ruff` and `mypy --strict` (config in [`pyproject.toml`](pyproject.toml)):
+
+- Line length 100, target `py312`.
+- Lint rule sets: `E`, `F`, `I`, `UP`, `B`, `SIM`, `RUF`.
+- `from __future__ import annotations` at the top of every module.
+- Built-in generics and `|` unions; no `typing.Any` in generics. Full strict typing — no untyped defs, no implicit `Any`.
+- Pydantic models for every typed boundary.
+
+No silent failures: fail loud rather than falling back. A half-configured provider should error, not degrade to a default (see [configuration](docs/configuration.md)). No `try/except ImportError`, no placeholder/mock values in shipped code.
+
+## Tests
+
+`tests/` mirrors the source tree — one directory per subsystem (`okf/`, `dedup/`, `merge/`, `contradiction/`, `link/`, `indexlog/`, `pipeline/`, `mcp/`, `providers/`, `index/`, `bench/`, `validate/`). `evals/` holds the per-LLM-surface eval gates scored against the seed labels in `labels/`.
+
+When adding behavior:
+
+- Add tests next to the subsystem you changed; assert observable behavior and invariants (round-trip stability, no edit-drift, no silent overwrite), not incidental defaults.
+- Touching an LLM surface (extract, dedup, merge, relate, contradict) means updating its eval suite under `evals/` and, where relevant, the seed labels.
+- Changing the on-disk format means updating the conformance/round-trip tests under `tests/okf` and `tests/validate`.
+- Keep the default providers deterministic so the suite stays offline and reproducible.
+
+`pytest` discovers both `tests` and `evals` (`testpaths` in `pyproject.toml`).
+
+## Commits and pull requests
+
+Follow [Conventional Commits 1.0.0](https://www.conventionalcommits.org/):
+
+```text
+<type>[optional scope]: <description>
+```
+
+Types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`. Subject in imperative mood, lowercase, no trailing period, ≤72 chars. Breaking changes use `!` and/or a `BREAKING CHANGE:` footer.
+
+- One logical change per commit.
+- PR titles are valid Conventional Commit subjects (squash-merge uses them as the commit message).
+- PR body: what and why; call out breaking changes; link issues with `Closes #N` / `Refs #N`.
+- The PR must pass the full gate set above before review.
+
+## Non-negotiables
+
+- The artifact stays open and self-sufficient: output is plain OKF files; no proprietary store on the critical path.
+- Every write goes through the plan → approve → commit gate; no silent mutation of a bundle.
+- Conformance is a gate, not a guideline: non-conformant output never reaches `main`.
+- Model- and cloud-neutral: no dependency on a specific model, cloud, or agent framework outside the provider layer.

kosha_okf-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.