lanternkb 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lanternkb-0.1.0/.github/workflows/release.yml +75 -0
- lanternkb-0.1.0/.github/workflows/tests.yml +95 -0
- lanternkb-0.1.0/.gitignore +17 -0
- lanternkb-0.1.0/.gitleaks.toml +14 -0
- lanternkb-0.1.0/.python-version +1 -0
- lanternkb-0.1.0/CLAUDE.md +159 -0
- lanternkb-0.1.0/CODE_OF_CONDUCT.md +10 -0
- lanternkb-0.1.0/CONTRIBUTING.md +41 -0
- lanternkb-0.1.0/LICENSE +202 -0
- lanternkb-0.1.0/NOTICE +5 -0
- lanternkb-0.1.0/PKG-INFO +117 -0
- lanternkb-0.1.0/README.md +78 -0
- lanternkb-0.1.0/SECURITY.md +25 -0
- lanternkb-0.1.0/THIRD_PARTY_NOTICES.md +9 -0
- lanternkb-0.1.0/bench/README.md +39 -0
- lanternkb-0.1.0/bench/analysis-plan.md +90 -0
- lanternkb-0.1.0/bench/blind3-rerank-plan.md +84 -0
- lanternkb-0.1.0/bench/blind3-test-log.md +10 -0
- lanternkb-0.1.0/bench/corpus.fingerprint +1 -0
- lanternkb-0.1.0/bench/explore-rerank.py +199 -0
- lanternkb-0.1.0/bench/explore-rerank2.py +148 -0
- lanternkb-0.1.0/bench/explore-routing.py +136 -0
- lanternkb-0.1.0/bench/injection/build.py +119 -0
- lanternkb-0.1.0/bench/injection-plan.md +48 -0
- lanternkb-0.1.0/bench/injection-test-log.md +7 -0
- lanternkb-0.1.0/bench/phase5-analysis-plan.md +82 -0
- lanternkb-0.1.0/bench/phase5-dev-log.md +94 -0
- lanternkb-0.1.0/bench/phase5-test-log.md +13 -0
- lanternkb-0.1.0/bench/phase9-routing-plan.md +80 -0
- lanternkb-0.1.0/bench/phase9-test-log.md +10 -0
- lanternkb-0.1.0/bench/queries/all.jsonl +407 -0
- lanternkb-0.1.0/bench/queries/blind3_a.jsonl +170 -0
- lanternkb-0.1.0/bench/queries/blind3_b.jsonl +130 -0
- lanternkb-0.1.0/bench/queries/code_nl.jsonl +90 -0
- lanternkb-0.1.0/bench/queries/phase5_test.jsonl +330 -0
- lanternkb-0.1.0/bench/queries/phase9_test_a.jsonl +170 -0
- lanternkb-0.1.0/bench/queries/phase9_test_b.jsonl +130 -0
- lanternkb-0.1.0/bench/results/blind3/rerank.json +122 -0
- lanternkb-0.1.0/bench/results/blind3/rerank.md +20 -0
- lanternkb-0.1.0/bench/results/injection/runs.json +1988 -0
- lanternkb-0.1.0/bench/results/injection/summary.json +59 -0
- lanternkb-0.1.0/bench/results/phase1/dev-per-query.json +1 -0
- lanternkb-0.1.0/bench/results/phase1/dev-selection.json +8 -0
- lanternkb-0.1.0/bench/results/phase1/dev-summary.json +3033 -0
- lanternkb-0.1.0/bench/results/phase1/dev-tables.md +69 -0
- lanternkb-0.1.0/bench/results/phase1/test-per-query.json +1 -0
- lanternkb-0.1.0/bench/results/phase1/test-summary.json +3081 -0
- lanternkb-0.1.0/bench/results/phase1/test-tables.md +69 -0
- lanternkb-0.1.0/bench/results/phase2/dev-summary.json +1223 -0
- lanternkb-0.1.0/bench/results/phase2/dev-tables.md +93 -0
- lanternkb-0.1.0/bench/results/phase2/test-summary.json +1924 -0
- lanternkb-0.1.0/bench/results/phase2/test-tables.md +167 -0
- lanternkb-0.1.0/bench/results/phase5/dev-per-query.json +1 -0
- lanternkb-0.1.0/bench/results/phase5/dev-summary.json +9096 -0
- lanternkb-0.1.0/bench/results/phase5/dev-tables.md +132 -0
- lanternkb-0.1.0/bench/results/phase5/test-per-query.json +1 -0
- lanternkb-0.1.0/bench/results/phase5/test-summary.json +1731 -0
- lanternkb-0.1.0/bench/results/phase5/test-tables.md +48 -0
- lanternkb-0.1.0/bench/results/phase9/routing.json +103 -0
- lanternkb-0.1.0/bench/results/phase9/routing.md +19 -0
- lanternkb-0.1.0/bench/results/rerank-exploration/round1.json +731 -0
- lanternkb-0.1.0/bench/results/rerank-exploration/round1.txt +56 -0
- lanternkb-0.1.0/bench/results/rerank-exploration/round2.json +4536 -0
- lanternkb-0.1.0/bench/results/rerank-exploration/round2.txt +32 -0
- lanternkb-0.1.0/bench/results/secrets2/secrets2.json +512 -0
- lanternkb-0.1.0/bench/results/secrets3/secrets3.json +1141 -0
- lanternkb-0.1.0/bench/results/secrets4/secrets4.json +762 -0
- lanternkb-0.1.0/bench/results/secrets5/secrets5.json +903 -0
- lanternkb-0.1.0/bench/results/secrets6/secrets6.json +1285 -0
- lanternkb-0.1.0/bench/results/secrets7/secrets7.json +681 -0
- lanternkb-0.1.0/bench/run-blind3-rerank.py +46 -0
- lanternkb-0.1.0/bench/run-injection.py +185 -0
- lanternkb-0.1.0/bench/run-phase1.sh +24 -0
- lanternkb-0.1.0/bench/run-phase5.sh +31 -0
- lanternkb-0.1.0/bench/run-phase9-routing.py +46 -0
- lanternkb-0.1.0/bench/run-secrets2.py +113 -0
- lanternkb-0.1.0/bench/run-secrets3.py +177 -0
- lanternkb-0.1.0/bench/run-secrets4.py +138 -0
- lanternkb-0.1.0/bench/run-secrets5.py +149 -0
- lanternkb-0.1.0/bench/run-secrets6.py +168 -0
- lanternkb-0.1.0/bench/run-secrets7.py +164 -0
- lanternkb-0.1.0/bench/scale-phase5.py +144 -0
- lanternkb-0.1.0/bench/score-blind3-rerank.py +97 -0
- lanternkb-0.1.0/bench/score-phase9-routing.py +83 -0
- lanternkb-0.1.0/bench/search-ideas-log.md +8 -0
- lanternkb-0.1.0/bench/secrets-analysis-plan.md +62 -0
- lanternkb-0.1.0/bench/secrets-test-log.md +7 -0
- lanternkb-0.1.0/bench/secrets2-plan.md +76 -0
- lanternkb-0.1.0/bench/secrets2-test-log.md +7 -0
- lanternkb-0.1.0/bench/secrets3-plan.md +99 -0
- lanternkb-0.1.0/bench/secrets3-test-log.md +7 -0
- lanternkb-0.1.0/bench/secrets4-plan.md +54 -0
- lanternkb-0.1.0/bench/secrets4-test-log.md +7 -0
- lanternkb-0.1.0/bench/secrets5-plan.md +71 -0
- lanternkb-0.1.0/bench/secrets5-test-log.md +7 -0
- lanternkb-0.1.0/bench/secrets6-plan.md +85 -0
- lanternkb-0.1.0/bench/secrets6-test-log.md +7 -0
- lanternkb-0.1.0/bench/secrets7-plan.md +96 -0
- lanternkb-0.1.0/bench/secrets7-test-log.md +1 -0
- lanternkb-0.1.0/bench/test-split-log.md +29 -0
- lanternkb-0.1.0/bench/tools/gitleaks/NOTES.md +69 -0
- lanternkb-0.1.0/bench/tools/gitleaks/install.sh +37 -0
- lanternkb-0.1.0/bench/tools/grooveseek/NOTES.md +64 -0
- lanternkb-0.1.0/bench/tools/grooveseek/install.sh +45 -0
- lanternkb-0.1.0/bench/tools/qmd/NOTES.md +42 -0
- lanternkb-0.1.0/bench/tools/qmd/install.sh +7 -0
- lanternkb-0.1.0/bench/tools/qmd/package-lock.json +2370 -0
- lanternkb-0.1.0/bench/tools/qmd/package.json +8 -0
- lanternkb-0.1.0/docs/decisions/0001-open-source-apache-2.md +18 -0
- lanternkb-0.1.0/docs/decisions/0002-safety-first-ingestion.md +19 -0
- lanternkb-0.1.0/docs/decisions/0003-stdio-mcp-no-daemon.md +19 -0
- lanternkb-0.1.0/docs/decisions/0004-reuse-or-build-gate.md +21 -0
- lanternkb-0.1.0/docs/decisions/0005-zero-claude-tokens-at-runtime.md +18 -0
- lanternkb-0.1.0/docs/decisions/0006-tiers-enforced-by-server.md +19 -0
- lanternkb-0.1.0/docs/decisions/0007-on-demand-settings-ui.md +20 -0
- lanternkb-0.1.0/docs/decisions/0008-features-are-isolated-plugins.md +21 -0
- lanternkb-0.1.0/docs/decisions/0009-efficiency-budgets.md +19 -0
- lanternkb-0.1.0/docs/decisions/0010-no-license-keys-or-tracking-in-core.md +21 -0
- lanternkb-0.1.0/docs/decisions/0011-build-our-own-core.md +20 -0
- lanternkb-0.1.0/docs/decisions/0012-licence-undecided-stay-closed-ready.md +22 -0
- lanternkb-0.1.0/docs/decisions/0013-scanner-rules-from-gitleaks.md +19 -0
- lanternkb-0.1.0/docs/decisions/0014-feature-state-in-config-mirrored-in-index.md +20 -0
- lanternkb-0.1.0/docs/decisions/0015-extractors-isolated-permissive.md +20 -0
- lanternkb-0.1.0/docs/decisions/0016-search-routing-embeddinggemma.md +39 -0
- lanternkb-0.1.0/docs/decisions/0017-own-minimal-mcp-server.md +31 -0
- lanternkb-0.1.0/docs/decisions/0018-plugins-entry-points-off-until-enabled.md +32 -0
- lanternkb-0.1.0/docs/decisions/0019-plugins-fail-closed-and-never-mix.md +42 -0
- lanternkb-0.1.0/docs/decisions/0020-vectors-in-plain-tables-binary-shortlist.md +64 -0
- lanternkb-0.1.0/docs/decisions/0021-open-media-shares-no-gpu-state.md +26 -0
- lanternkb-0.1.0/docs/decisions/0022-rerank-top-files-by-default.md +33 -0
- lanternkb-0.1.0/docs/decisions/0023-keep-the-name-lanternkb.md +20 -0
- lanternkb-0.1.0/docs/decisions/0024-onnx-for-one-off-searches-and-linux-reranking.md +31 -0
- lanternkb-0.1.0/docs/decisions/0025-round-4-on-by-default.md +30 -0
- lanternkb-0.1.0/docs/decisions/0026-round-3-on-by-default.md +25 -0
- lanternkb-0.1.0/docs/decisions/0027-round-6-on-by-default.md +33 -0
- lanternkb-0.1.0/docs/decisions/0028-apache-2-and-public-release.md +37 -0
- lanternkb-0.1.0/docs/efficiency.md +40 -0
- lanternkb-0.1.0/docs/guide.md +111 -0
- lanternkb-0.1.0/docs/hld.md +74 -0
- lanternkb-0.1.0/docs/launch/announcement-draft.md +56 -0
- lanternkb-0.1.0/docs/lld/evaluation.md +35 -0
- lanternkb-0.1.0/docs/lld/extension-api.md +84 -0
- lanternkb-0.1.0/docs/lld/features-ui.md +160 -0
- lanternkb-0.1.0/docs/lld/index-search.md +113 -0
- lanternkb-0.1.0/docs/lld/ingest.md +83 -0
- lanternkb-0.1.0/docs/lld/mcp-runtime.md +94 -0
- lanternkb-0.1.0/docs/lld/safety.md +94 -0
- lanternkb-0.1.0/docs/name-check.md +38 -0
- lanternkb-0.1.0/docs/plugins.md +284 -0
- lanternkb-0.1.0/docs/prfaq.md +36 -0
- lanternkb-0.1.0/docs/prior-art.md +40 -0
- lanternkb-0.1.0/docs/results/blind3-rerank.md +75 -0
- lanternkb-0.1.0/docs/results/evaluation-report.md +288 -0
- lanternkb-0.1.0/docs/results/injection.md +50 -0
- lanternkb-0.1.0/docs/results/phase1-bakeoff.md +115 -0
- lanternkb-0.1.0/docs/results/phase2-safety.md +93 -0
- lanternkb-0.1.0/docs/results/phase3-features.md +76 -0
- lanternkb-0.1.0/docs/results/phase4-extractors.md +60 -0
- lanternkb-0.1.0/docs/results/phase5-search.md +139 -0
- lanternkb-0.1.0/docs/results/phase6-mcp.md +91 -0
- lanternkb-0.1.0/docs/results/phase7-ui.md +51 -0
- lanternkb-0.1.0/docs/results/phase8-plugins.md +76 -0
- lanternkb-0.1.0/docs/results/phase9-routing.md +56 -0
- lanternkb-0.1.0/docs/results/quick-search.md +82 -0
- lanternkb-0.1.0/docs/results/real-files-1.md +42 -0
- lanternkb-0.1.0/docs/results/secrets2.md +78 -0
- lanternkb-0.1.0/docs/results/secrets3.md +100 -0
- lanternkb-0.1.0/docs/results/secrets4.md +46 -0
- lanternkb-0.1.0/docs/results/secrets5.md +61 -0
- lanternkb-0.1.0/docs/results/secrets6.md +50 -0
- lanternkb-0.1.0/docs/results/secrets7.md +69 -0
- lanternkb-0.1.0/docs/roadmap.md +49 -0
- lanternkb-0.1.0/docs/threat-model.md +42 -0
- lanternkb-0.1.0/packages/lanternkb-dev/pyproject.toml +21 -0
- lanternkb-0.1.0/packages/lanternkb-dev/src/lanternkb_dev/__init__.py +1 -0
- lanternkb-0.1.0/packages/lanternkb-epub/pyproject.toml +20 -0
- lanternkb-0.1.0/packages/lanternkb-epub/src/lanternkb_epub/__init__.py +121 -0
- lanternkb-0.1.0/packages/lanternkb-epub/src/lanternkb_epub/lanternkb_feature.toml +22 -0
- lanternkb-0.1.0/packages/lanternkb-epub/tests/test_contract.py +61 -0
- lanternkb-0.1.0/packages/lanternkb-ui/LICENSE +202 -0
- lanternkb-0.1.0/packages/lanternkb-ui/NOTICE +5 -0
- lanternkb-0.1.0/packages/lanternkb-ui/README.md +7 -0
- lanternkb-0.1.0/packages/lanternkb-ui/pyproject.toml +20 -0
- lanternkb-0.1.0/packages/lanternkb-ui/src/lanternkb_ui/__init__.py +1 -0
- lanternkb-0.1.0/packages/lanternkb-ui/src/lanternkb_ui/app.py +627 -0
- lanternkb-0.1.0/packages/lanternkb-ui/src/lanternkb_ui/page.py +418 -0
- lanternkb-0.1.0/pyproject.toml +126 -0
- lanternkb-0.1.0/scripts/audit_deps.sh +17 -0
- lanternkb-0.1.0/scripts/check_licences.py +109 -0
- lanternkb-0.1.0/scripts/check_secrets_regression.py +52 -0
- lanternkb-0.1.0/scripts/check_ui_layout.py +215 -0
- lanternkb-0.1.0/scripts/check_wheel.py +54 -0
- lanternkb-0.1.0/scripts/ci/linux.Dockerfile +14 -0
- lanternkb-0.1.0/scripts/ci_local.sh +48 -0
- lanternkb-0.1.0/scripts/scan_history.sh +24 -0
- lanternkb-0.1.0/scripts/scan_repo.py +77 -0
- lanternkb-0.1.0/src/lanternkb/__init__.py +3 -0
- lanternkb-0.1.0/src/lanternkb/chunking.py +166 -0
- lanternkb-0.1.0/src/lanternkb/cli.py +889 -0
- lanternkb-0.1.0/src/lanternkb/config.py +257 -0
- lanternkb-0.1.0/src/lanternkb/control.py +586 -0
- lanternkb-0.1.0/src/lanternkb/doctor.py +314 -0
- lanternkb-0.1.0/src/lanternkb/embed/__init__.py +474 -0
- lanternkb-0.1.0/src/lanternkb/eval/__init__.py +1 -0
- lanternkb-0.1.0/src/lanternkb/eval/cli.py +140 -0
- lanternkb-0.1.0/src/lanternkb/eval/corpus/__init__.py +0 -0
- lanternkb-0.1.0/src/lanternkb/eval/corpus/build.py +54 -0
- lanternkb-0.1.0/src/lanternkb/eval/corpus/code_queries.py +74 -0
- lanternkb-0.1.0/src/lanternkb/eval/corpus/notes.py +1556 -0
- lanternkb-0.1.0/src/lanternkb/eval/corpus/sources.py +94 -0
- lanternkb-0.1.0/src/lanternkb/eval/mcp_client.py +160 -0
- lanternkb-0.1.0/src/lanternkb/eval/measure.py +114 -0
- lanternkb-0.1.0/src/lanternkb/eval/metrics.py +90 -0
- lanternkb-0.1.0/src/lanternkb/eval/phase5.py +149 -0
- lanternkb-0.1.0/src/lanternkb/eval/queries.py +75 -0
- lanternkb-0.1.0/src/lanternkb/eval/report.py +180 -0
- lanternkb-0.1.0/src/lanternkb/eval/runner.py +215 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/__init__.py +0 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/arms.py +134 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/clean_structured.py +10199 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/evaluate.py +266 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/planted_common.py +1153 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/planted_dev.py +792 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/planted_test.py +1223 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/planted_test2.py +1221 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/planted_test3.py +2268 -0
- lanternkb-0.1.0/src/lanternkb/eval/secrets/report.py +251 -0
- lanternkb-0.1.0/src/lanternkb/eval/systems/__init__.py +23 -0
- lanternkb-0.1.0/src/lanternkb/eval/systems/base.py +86 -0
- lanternkb-0.1.0/src/lanternkb/eval/systems/baselines.py +355 -0
- lanternkb-0.1.0/src/lanternkb/eval/systems/chunking.py +26 -0
- lanternkb-0.1.0/src/lanternkb/eval/systems/grooveseek.py +208 -0
- lanternkb-0.1.0/src/lanternkb/eval/systems/lanternkb.py +334 -0
- lanternkb-0.1.0/src/lanternkb/eval/systems/qmd.py +307 -0
- lanternkb-0.1.0/src/lanternkb/extract/__init__.py +81 -0
- lanternkb-0.1.0/src/lanternkb/extract/archive.py +122 -0
- lanternkb-0.1.0/src/lanternkb/extract/audio.py +220 -0
- lanternkb-0.1.0/src/lanternkb/extract/base.py +95 -0
- lanternkb-0.1.0/src/lanternkb/extract/linux_sandbox.py +224 -0
- lanternkb-0.1.0/src/lanternkb/extract/markup.py +224 -0
- lanternkb-0.1.0/src/lanternkb/extract/ocr.py +141 -0
- lanternkb-0.1.0/src/lanternkb/extract/odf.py +333 -0
- lanternkb-0.1.0/src/lanternkb/extract/office.py +367 -0
- lanternkb-0.1.0/src/lanternkb/extract/pdf.py +135 -0
- lanternkb-0.1.0/src/lanternkb/extract/pool.py +660 -0
- lanternkb-0.1.0/src/lanternkb/extract/rtf.py +194 -0
- lanternkb-0.1.0/src/lanternkb/extract/testing.py +311 -0
- lanternkb-0.1.0/src/lanternkb/extract/text.py +52 -0
- lanternkb-0.1.0/src/lanternkb/extract/tools.py +44 -0
- lanternkb-0.1.0/src/lanternkb/extract/worker.py +386 -0
- lanternkb-0.1.0/src/lanternkb/features/__init__.py +214 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/embedder.bge-small.toml +14 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/embedder.embeddinggemma-300m.toml +14 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/embedder.qwen3-0.6b.toml +14 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/extractor.audio.toml +22 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/extractor.code.toml +32 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/extractor.images.toml +22 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/extractor.office.toml +22 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/extractor.opendocument.toml +23 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/extractor.pdf.toml +22 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/extractor.text.toml +26 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/reranker.gte-modernbert.toml +14 -0
- lanternkb-0.1.0/src/lanternkb/features/builtin/scanner.secrets.toml +14 -0
- lanternkb-0.1.0/src/lanternkb/fsutil.py +55 -0
- lanternkb-0.1.0/src/lanternkb/globs.py +158 -0
- lanternkb-0.1.0/src/lanternkb/hints.py +53 -0
- lanternkb-0.1.0/src/lanternkb/ingest.py +703 -0
- lanternkb-0.1.0/src/lanternkb/models.py +171 -0
- lanternkb-0.1.0/src/lanternkb/plugins.py +250 -0
- lanternkb-0.1.0/src/lanternkb/policy.py +275 -0
- lanternkb-0.1.0/src/lanternkb/power.py +70 -0
- lanternkb-0.1.0/src/lanternkb/redaction.py +151 -0
- lanternkb-0.1.0/src/lanternkb/rerank.py +273 -0
- lanternkb-0.1.0/src/lanternkb/scan/__init__.py +1 -0
- lanternkb-0.1.0/src/lanternkb/scan/engine.py +1434 -0
- lanternkb-0.1.0/src/lanternkb/scan/rules/gitleaks.LICENSE +21 -0
- lanternkb-0.1.0/src/lanternkb/scan/rules/gitleaks.toml +3209 -0
- lanternkb-0.1.0/src/lanternkb/scan/rules/lanternkb.toml +852 -0
- lanternkb-0.1.0/src/lanternkb/scan/rules.py +409 -0
- lanternkb-0.1.0/src/lanternkb/scan/views.py +605 -0
- lanternkb-0.1.0/src/lanternkb/schedule.py +154 -0
- lanternkb-0.1.0/src/lanternkb/search.py +679 -0
- lanternkb-0.1.0/src/lanternkb/server.py +818 -0
- lanternkb-0.1.0/src/lanternkb/store.py +1123 -0
- lanternkb-0.1.0/src/lanternkb/testing.py +161 -0
- lanternkb-0.1.0/src/lanternkb/text.py +33 -0
- lanternkb-0.1.0/src/lanternkb/tiers.py +107 -0
- lanternkb-0.1.0/tests/conftest.py +52 -0
- lanternkb-0.1.0/tests/docfixtures.py +298 -0
- lanternkb-0.1.0/tests/fakes.py +96 -0
- lanternkb-0.1.0/tests/fixtures/onnx_reference.json +1 -0
- lanternkb-0.1.0/tests/fixtures/rerank_reference.json +19 -0
- lanternkb-0.1.0/tests/serverkit.py +28 -0
- lanternkb-0.1.0/tests/test_adapters_slow.py +58 -0
- lanternkb-0.1.0/tests/test_eval.py +110 -0
- lanternkb-0.1.0/tests/test_extract_documents.py +291 -0
- lanternkb-0.1.0/tests/test_extract_formats.py +684 -0
- lanternkb-0.1.0/tests/test_extract_media.py +311 -0
- lanternkb-0.1.0/tests/test_features.py +353 -0
- lanternkb-0.1.0/tests/test_issue21.py +83 -0
- lanternkb-0.1.0/tests/test_k8s_secret_data.py +61 -0
- lanternkb-0.1.0/tests/test_linux_sandbox.py +120 -0
- lanternkb-0.1.0/tests/test_onnx_embedder.py +166 -0
- lanternkb-0.1.0/tests/test_phase9_fixes.py +524 -0
- lanternkb-0.1.0/tests/test_planted.py +166 -0
- lanternkb-0.1.0/tests/test_plugins.py +289 -0
- lanternkb-0.1.0/tests/test_quick_search.py +304 -0
- lanternkb-0.1.0/tests/test_release.py +48 -0
- lanternkb-0.1.0/tests/test_rerank.py +218 -0
- lanternkb-0.1.0/tests/test_review10_fixes.py +108 -0
- lanternkb-0.1.0/tests/test_review11_fixes.py +343 -0
- lanternkb-0.1.0/tests/test_review12_fixes.py +236 -0
- lanternkb-0.1.0/tests/test_review3_fixes.py +262 -0
- lanternkb-0.1.0/tests/test_review4_fixes.py +197 -0
- lanternkb-0.1.0/tests/test_review5_fixes.py +473 -0
- lanternkb-0.1.0/tests/test_review6_fixes.py +313 -0
- lanternkb-0.1.0/tests/test_review7_fixes.py +250 -0
- lanternkb-0.1.0/tests/test_review8_fixes.py +392 -0
- lanternkb-0.1.0/tests/test_review9_fixes.py +96 -0
- lanternkb-0.1.0/tests/test_review_fixes.py +306 -0
- lanternkb-0.1.0/tests/test_safety.py +339 -0
- lanternkb-0.1.0/tests/test_scanner_sweep.py +50 -0
- lanternkb-0.1.0/tests/test_search_filters.py +281 -0
- lanternkb-0.1.0/tests/test_secret_rules_15.py +198 -0
- lanternkb-0.1.0/tests/test_secret_rules_16.py +260 -0
- lanternkb-0.1.0/tests/test_secret_rules_17.py +163 -0
- lanternkb-0.1.0/tests/test_secret_rules_18.py +162 -0
- lanternkb-0.1.0/tests/test_secret_rules_19.py +124 -0
- lanternkb-0.1.0/tests/test_secret_rules_2026_10.py +149 -0
- lanternkb-0.1.0/tests/test_secret_rules_29.py +36 -0
- lanternkb-0.1.0/tests/test_secret_rules_31.py +64 -0
- lanternkb-0.1.0/tests/test_secret_rules_32.py +204 -0
- lanternkb-0.1.0/tests/test_secret_rules_33.py +224 -0
- lanternkb-0.1.0/tests/test_secret_rules_34.py +197 -0
- lanternkb-0.1.0/tests/test_secret_rules_36.py +329 -0
- lanternkb-0.1.0/tests/test_server.py +402 -0
- lanternkb-0.1.0/tests/test_setup.py +254 -0
- lanternkb-0.1.0/tests/test_snippets.py +52 -0
- lanternkb-0.1.0/tests/test_ui.py +482 -0
- lanternkb-0.1.0/tests/test_vectors.py +399 -0
- lanternkb-0.1.0/tests/test_worker.py +291 -0
- lanternkb-0.1.0/uv.lock +2533 -0
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Publishes lanternkb and lanternkb-ui to PyPI when a version tag (v0.1.0) is pushed (decision 0028).
|
|
2
|
+
# Trusted publishing: no token is stored anywhere. PyPI trusts this workflow in the `pypi` environment for lanternkb
|
|
3
|
+
# and in `pypi-ui` for lanternkb-ui: PyPI takes one pending publisher per repository, workflow and environment, so the
|
|
4
|
+
# two projects need two environments. Each is set up once on pypi.org (decision 0028, "Setting up PyPI").
|
|
5
|
+
name: release
|
|
6
|
+
|
|
7
|
+
on:
|
|
8
|
+
push:
|
|
9
|
+
tags: ["v*"]
|
|
10
|
+
workflow_dispatch: # a dry run: build and check, never publish (`gh workflow run release.yml`)
|
|
11
|
+
|
|
12
|
+
permissions:
|
|
13
|
+
contents: read
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
build:
|
|
17
|
+
runs-on: ubuntu-latest
|
|
18
|
+
timeout-minutes: 15
|
|
19
|
+
steps:
|
|
20
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
21
|
+
- uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
|
22
|
+
- name: The tag matches every version
|
|
23
|
+
if: github.ref_type == 'tag'
|
|
24
|
+
run: |
|
|
25
|
+
v="${GITHUB_REF_NAME#v}"
|
|
26
|
+
grep -qx "version = \"$v\"" pyproject.toml
|
|
27
|
+
grep -qx "version = \"$v\"" packages/lanternkb-ui/pyproject.toml
|
|
28
|
+
grep -qx "__version__ = \"$v\"" src/lanternkb/__init__.py
|
|
29
|
+
grep -q "\"lanternkb-ui==$v\"" pyproject.toml
|
|
30
|
+
grep -q "\"lanternkb==$v\"" packages/lanternkb-ui/pyproject.toml
|
|
31
|
+
- name: The wheel ships no evaluation harness and nothing gitleaks flags (issue #28)
|
|
32
|
+
run: uv run --no-project --python 3.12 python scripts/check_wheel.py # standard library only
|
|
33
|
+
- run: uv build --package lanternkb --out-dir dist/lanternkb
|
|
34
|
+
- run: uv build --package lanternkb-ui --out-dir dist/lanternkb-ui
|
|
35
|
+
- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
36
|
+
with:
|
|
37
|
+
name: lanternkb
|
|
38
|
+
path: dist/lanternkb/
|
|
39
|
+
if-no-files-found: error
|
|
40
|
+
- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
41
|
+
with:
|
|
42
|
+
name: lanternkb-ui
|
|
43
|
+
path: dist/lanternkb-ui/
|
|
44
|
+
if-no-files-found: error
|
|
45
|
+
|
|
46
|
+
publish-lanternkb:
|
|
47
|
+
needs: build
|
|
48
|
+
if: github.ref_type == 'tag'
|
|
49
|
+
runs-on: ubuntu-latest
|
|
50
|
+
timeout-minutes: 10
|
|
51
|
+
environment: pypi
|
|
52
|
+
permissions:
|
|
53
|
+
id-token: write # trusted publishing
|
|
54
|
+
steps:
|
|
55
|
+
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
|
56
|
+
with:
|
|
57
|
+
name: lanternkb
|
|
58
|
+
path: dist/
|
|
59
|
+
- uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
|
|
60
|
+
|
|
61
|
+
# After lanternkb, which it pins: never a settings page on PyPI without the version it needs.
|
|
62
|
+
publish-lanternkb-ui:
|
|
63
|
+
needs: publish-lanternkb
|
|
64
|
+
if: github.ref_type == 'tag'
|
|
65
|
+
runs-on: ubuntu-latest
|
|
66
|
+
timeout-minutes: 10
|
|
67
|
+
environment: pypi-ui
|
|
68
|
+
permissions:
|
|
69
|
+
id-token: write # trusted publishing
|
|
70
|
+
steps:
|
|
71
|
+
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
|
72
|
+
with:
|
|
73
|
+
name: lanternkb-ui
|
|
74
|
+
path: dist/
|
|
75
|
+
- uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Lint and the fast test tier. Linux runs on every push; macOS (where the extraction
|
|
2
|
+
# sandbox exists) runs on demand, because private-repo macOS minutes cost 10x.
|
|
3
|
+
# Actions are pinned by commit. No secrets are used, and the token is read-only.
|
|
4
|
+
name: tests
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
branches: [main]
|
|
9
|
+
pull_request:
|
|
10
|
+
workflow_dispatch:
|
|
11
|
+
inputs:
|
|
12
|
+
macos:
|
|
13
|
+
description: "Also run on macOS (sandbox tests)"
|
|
14
|
+
type: boolean
|
|
15
|
+
default: false
|
|
16
|
+
onnx:
|
|
17
|
+
description: "Also run semantic search on Linux with the real model (1.2 GB download)"
|
|
18
|
+
type: boolean
|
|
19
|
+
default: false
|
|
20
|
+
|
|
21
|
+
permissions:
|
|
22
|
+
contents: read
|
|
23
|
+
|
|
24
|
+
concurrency:
|
|
25
|
+
group: tests-${{ github.ref }}-${{ github.event_name }}
|
|
26
|
+
cancel-in-progress: true
|
|
27
|
+
|
|
28
|
+
jobs:
|
|
29
|
+
linux:
|
|
30
|
+
runs-on: ubuntu-latest
|
|
31
|
+
timeout-minutes: 20
|
|
32
|
+
steps:
|
|
33
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
34
|
+
with:
|
|
35
|
+
persist-credentials: false
|
|
36
|
+
- uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
|
37
|
+
with:
|
|
38
|
+
version: "0.12.18"
|
|
39
|
+
# The bench group (torch, tiktoken) is for evaluation only; on Linux torch would
|
|
40
|
+
# pull non-permissive CUDA libraries. Two token-budget tests skip without tiktoken.
|
|
41
|
+
# The extras on Linux: semantic search through ONNX Runtime (issue #12).
|
|
42
|
+
- run: uv sync --locked --all-extras --no-group bench
|
|
43
|
+
- run: | # the kernel's security modules and Landlock's version; the sandbox must be on (#10)
|
|
44
|
+
uname -r; cat /sys/kernel/security/lsm || true; echo
|
|
45
|
+
uv run --no-sync python -c "from lanternkb.extract import linux_sandbox as l, pool; print('landlock', l.abi()); assert pool.sandbox_available()"
|
|
46
|
+
- run: uv run --no-sync pytest -v -p no:cacheprovider tests/test_linux_sandbox.py
|
|
47
|
+
- run: uv run --no-sync ruff check .
|
|
48
|
+
- run: uv run --no-sync ruff format --check src tests packages
|
|
49
|
+
- run: uv run --no-sync pytest -q -rs -p no:cacheprovider
|
|
50
|
+
- run: uv run --no-sync python scripts/check_licences.py # Linux's set of extras
|
|
51
|
+
- run: ./scripts/audit_deps.sh # SBOM and known-vulnerability check (OSV)
|
|
52
|
+
|
|
53
|
+
linux-onnx:
|
|
54
|
+
if: github.event_name == 'workflow_dispatch' && inputs.onnx
|
|
55
|
+
runs-on: ubuntu-latest
|
|
56
|
+
timeout-minutes: 30
|
|
57
|
+
env:
|
|
58
|
+
LANTERNKB_MODELS_DIR: ${{ github.workspace }}/.models
|
|
59
|
+
steps:
|
|
60
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
61
|
+
with:
|
|
62
|
+
persist-credentials: false
|
|
63
|
+
- uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
|
64
|
+
with:
|
|
65
|
+
version: "0.12.18"
|
|
66
|
+
- run: uv sync --locked --all-extras --no-group bench
|
|
67
|
+
# The pinned ONNX export, fetched by lanternkb's own pull (the only network code).
|
|
68
|
+
- run: uv run --no-sync lanternkb models pull embed:embeddinggemma-300m
|
|
69
|
+
- run: uv run --no-sync lanternkb models pull rerank:gte-modernbert
|
|
70
|
+
# Its vectors and scores must match references made on macOS (tests/fixtures/
|
|
71
|
+
# onnx_reference.json, rerank_reference.json).
|
|
72
|
+
- run: uv run --no-sync pytest -q -p no:cacheprovider -m slow tests/test_onnx_embedder.py tests/test_quick_search.py
|
|
73
|
+
|
|
74
|
+
macos:
|
|
75
|
+
if: github.event_name == 'workflow_dispatch' && inputs.macos
|
|
76
|
+
runs-on: macos-latest
|
|
77
|
+
timeout-minutes: 30
|
|
78
|
+
steps:
|
|
79
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
80
|
+
with:
|
|
81
|
+
persist-credentials: false
|
|
82
|
+
- uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
|
83
|
+
with:
|
|
84
|
+
version: "0.12.18"
|
|
85
|
+
# The extras (OCR, audio, semantic search) are macOS-only; their licences are checked here.
|
|
86
|
+
- run: uv sync --locked --all-extras --no-group bench
|
|
87
|
+
- run: | # says whether a sandboxed worker starts, before the tests
|
|
88
|
+
printf 'index = "%s/lk/index.db"\n' "$RUNNER_TEMP" > "$RUNNER_TEMP/lk.toml"
|
|
89
|
+
chmod 600 "$RUNNER_TEMP/lk.toml"
|
|
90
|
+
uv run --no-sync lanternkb --config "$RUNNER_TEMP/lk.toml" doctor || true
|
|
91
|
+
- run: uv run --no-sync pytest -q -p no:cacheprovider
|
|
92
|
+
- name: Sandbox denials (on failure)
|
|
93
|
+
if: failure()
|
|
94
|
+
run: /usr/bin/log show --last 10m --style compact --predicate 'eventMessage CONTAINS "deny"' | grep -E "python|Python" | tail -60
|
|
95
|
+
- run: uv run --no-sync python scripts/check_licences.py
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
.DS_Store
|
|
2
|
+
.venv/
|
|
3
|
+
__pycache__/
|
|
4
|
+
*.egg-info/
|
|
5
|
+
dist/
|
|
6
|
+
|
|
7
|
+
# never commit indexes, configs or personal data
|
|
8
|
+
*.db
|
|
9
|
+
*.db-wal
|
|
10
|
+
*.db-shm
|
|
11
|
+
config.toml
|
|
12
|
+
data/
|
|
13
|
+
runs/
|
|
14
|
+
.env*
|
|
15
|
+
|
|
16
|
+
# third-party tool installs for the bake-off
|
|
17
|
+
node_modules/
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Repository secret-scan settings: gitleaks' default rules, plus documented allowlists.
|
|
2
|
+
# The planted-secret evaluation's generators build FAKE secrets at run time from templates
|
|
3
|
+
# (labelled synthetic; hard rule 2). Their templates look like secrets to a scanner.
|
|
4
|
+
[extend]
|
|
5
|
+
useDefault = true
|
|
6
|
+
|
|
7
|
+
[[allowlists]]
|
|
8
|
+
description = "Synthetic fake-secret generators (src/lanternkb/eval/secrets/planted_*.py)"
|
|
9
|
+
paths = ['''src/lanternkb/eval/secrets/planted_[a-z0-9_]+\.py''']
|
|
10
|
+
|
|
11
|
+
[[allowlists]]
|
|
12
|
+
description = "Scanner rule tests with labelled, made-up example values (tests/test_secret_rules_*.py)"
|
|
13
|
+
paths = ['''tests/test_secret_rules_[0-9_]+\.py''', '''tests/test_k8s_secret_data\.py''',
|
|
14
|
+
'''tests/test_extract_formats\.py''']
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.12
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# lanternkb
|
|
2
|
+
|
|
3
|
+
A local-only search tool over a person's own files, with a secret-safe ingestion layer, visibility tiers, an MCP server over stdio and a published evaluation. Public repo: `ankitb073/lanternkb`, **Apache-2.0**, released as 0.1.0 on 2026-10-12 ([decision 0028](docs/decisions/0028-apache-2-and-public-release.md)): shipped dependencies must stay permissive; contributions are accepted under Apache-2.0; posting an announcement or creating accounts still needs the owner's yes. It began as an idea in `ankitb073/hq` (`ideas/2026-09-local-knowledge-base.md`). The name `lanternkb` was chosen on 2026-09-29 and kept by the owner on 2026-10-03 after the name check (decision 0023).
|
|
4
|
+
|
|
5
|
+
## Read first
|
|
6
|
+
|
|
7
|
+
1. [docs/prior-art.md](docs/prior-art.md): what exists, and the gap. Then [docs/results/phase1-bakeoff.md](docs/results/phase1-bakeoff.md): what the bake-off measured.
|
|
8
|
+
2. [docs/prfaq.md](docs/prfaq.md): the target and what would kill it.
|
|
9
|
+
3. [docs/threat-model.md](docs/threat-model.md): what we protect and do not claim.
|
|
10
|
+
4. [docs/hld.md](docs/hld.md) and [docs/lld/](docs/lld/): the design.
|
|
11
|
+
5. [docs/efficiency.md](docs/efficiency.md): the budgets every part is measured against.
|
|
12
|
+
6. [docs/roadmap.md](docs/roadmap.md): phases, and the release checklist.
|
|
13
|
+
7. [docs/decisions/](docs/decisions/).
|
|
14
|
+
|
|
15
|
+
Scope notes: email and browser history are **out of v1**. Every capability is an isolated, toggleable feature ([docs/lld/features-ui.md](docs/lld/features-ui.md)).
|
|
16
|
+
|
|
17
|
+
## Current state (2026-10-12)
|
|
18
|
+
|
|
19
|
+
**Phase 10 (public release), 2026-10-12, the owner's yes** ([decision 0028](docs/decisions/0028-apache-2-and-public-release.md)): Apache-2.0; the repo public with private vulnerability reporting; 0.1.0 of `lanternkb` and `lanternkb-ui` (the `ui` extra) through PyPI trusted publishing (`.github/workflows/release.yml`, on a `v*` tag). Install: `uv tool install --managed-python --python 3.12 "lanternkb[embed,ui]"` (a plain install on a fresh Mac picks Python 3.9 and fails). Added `lanternkb --version` and `tests/test_release.py` (one version everywhere, Apache-2.0 in every package). A clean-home install of the built wheels synced, searched, listed recent files and redacted a planted fake password. The announcement in `docs/launch/` is still the owner's to post.
|
|
20
|
+
|
|
21
|
+
**Phases 1 to 8 are done; phase 9 (hardening) is done except what needs the user.** Start with the [evaluation report](docs/results/evaluation-report.md), which gathers every phase's results, failures included. Phase reports: [1](docs/results/phase1-bakeoff.md), [2](docs/results/phase2-safety.md), [3](docs/results/phase3-features.md), [4](docs/results/phase4-extractors.md), [5](docs/results/phase5-search.md), [6](docs/results/phase6-mcp.md), [7](docs/results/phase7-ui.md), [8](docs/results/phase8-plugins.md), [9 routing](docs/results/phase9-routing.md).
|
|
22
|
+
|
|
23
|
+
- **Usable now** (README, "Try it"):
|
|
24
|
+
- `lanternkb serve --tier open|all`: the MCP server, checked live in Claude Code;
|
|
25
|
+
- `search`, `doctor`, `mcp-setup` (with suggested Claude Code deny rules), `install-schedule`, `--redact` for bug reports;
|
|
26
|
+
- `ui`: the settings page;
|
|
27
|
+
- plugins ([docs/plugins.md](docs/plugins.md)).
|
|
28
|
+
- **Search:**
|
|
29
|
+
- Phase 5 blind test (330 queries): nDCG@10 **0.831**, against 0.760 for QMD and 0.777 for grooveseek with its reranker.
|
|
30
|
+
- Phase 9 blind test (300 fresh queries): `ROUTE9` 0.829 against 0.820 for the phase 5 routing, so `ROUTE9` is the default routing (`search.DEFAULT`).
|
|
31
|
+
- **Third blind test (2026-10-03, 300 queries; 29 repeat tuning queries, see the results' sensitivity table): reranking the top 20 files** (gte-reranker-modernbert-base, fused with the search's order at RRF 5; `lanternkb.rerank`, [decision 0022](docs/decisions/0022-rerank-top-files-by-default.md)) scored **0.885** against 0.865; +0.033 over the vector part, meaningful as pre-registered (+0.029 without the 29 repeats, just under the bar), so **#14 is closed** and reranking is the default on macOS (`models pull rerank:gte-modernbert`). 138 / 187 ms per search. **All three blind sets are spent.**
|
|
32
|
+
- **ONNX ([decision 0024](docs/decisions/0024-onnx-for-one-off-searches-and-linux-reranking.md), [results](docs/results/quick-search.md)):** terminal searches load the ONNX exports when pulled (`models pull ... --backend onnx`): 0.54 s instead of 2.88 s (1.90 s instead of 3.24 s with reranking), same dev scores (#33 closed). Query vectors may cross backends within EmbeddingGemma's 257-token window. Reranking through ONNX on a CPU takes 0.4 to 1 s, over budget, so on Linux it is **opt-in** (`features enable reranker.gte-modernbert`; #25 closed; checked in the `linux-onnx` CI job).
|
|
33
|
+
- Dev nDCG@10: 0.854 with reranking (0.836 without), in-process and through MCP (123 / 182 ms).
|
|
34
|
+
- **Vectors (schema 8, [decision 0020](docs/decisions/0020-vectors-in-plain-tables-binary-shortlist.md)):** plain tables of float16 plus sign bits; an in-memory Hamming scan, then exact re-scoring of a shortlist (2% of visible, 4,000 to 20,000). 10 ms p50 at 100,000 chunks, 66 ms at 1,000,000; 363 MB per 100,000. sqlite-vec is loaded only to migrate old indexes.
|
|
35
|
+
- **Safety (published number 71.9%):** planted secrets kept out, on held-out splits: 87.5% (phase 2), 82.7% (second), **71.9%** [68.5%, 75.1%] (third, raw text; 84.5% through the pipeline; [results](docs/results/secrets3.md)). Since the third, splits are scored **through the pipeline** (what reaches the index), the primary measure.
|
|
36
|
+
- Fourth ([results](docs/results/secrets4.md)): fresh seeds of three generators; the default kept 92.6% out; round 3 (decoding views, `scan.rules.ROUND3`) added one secret, so it stays **opt-in** with round 2 (`scan.rules.OPT_IN`, `[scanner] enabled_rules`).
|
|
37
|
+
- **Fifth (2026-10-03, [results](docs/results/secrets5.md)):** fresh seeds of all four generators, 2,450 secrets. **Round 4** (`scan.rules.ROUND4`: YAML fold, punctuation and escaped-JSON views, multi-line CSV cells joined only inside tokens, `allowlist-resume`, three narrow rules) kept 31 more out (91.3% against 90.0%, +1.27 points [+0.86, +1.76]), +0 on the family it was not built from, the same 4 of 401 clean files flagged: **on by default** ([decision 0025](docs/decisions/0025-round-4-on-by-default.md), `ENGINE_VERSION` 13). Review 21 (and a follow-up) found a P1 in it before the test (resume skipped default matches), fixed.
|
|
38
|
+
- **Sixth (2026-10-07, [results](docs/results/secrets6.md)):** fresh seeds of all four generators, 2,448 secrets. **Round 3** (decoding views, fixed after review 23 on today's engine) kept 43 more out (92.9% against 91.1%, +1.76 points [+1.27, +2.29]), all on its own family, no loss elsewhere: **on by default** ([decision 0026](docs/decisions/0026-round-3-on-by-default.md), `ENGINE_VERSION` 15). **Round 5** (`scan.rules.ROUND5`: Windows command lines, `setx`, a password after a few words, #36) added 2 and stays opt-in.
|
|
39
|
+
- **Seventh (2026-10-08, [results](docs/results/secrets7.md)):** fresh seeds of all four generators, 2,455 secrets. **Round 6** (rules for indexed formats, three views, Kubernetes Secrets in JSON, word-bounded stopwords; review 27 found 3 P1 and 11 P2 before the run, all fixed) kept 36 more out (95.7% against 94.3%, +1.47 points [+1.02, +1.96]), every family gaining or holding, the same 5 of 401 clean files flagged: **on by default** ([decision 0027](docs/decisions/0027-round-6-on-by-default.md), `ENGINE_VERSION` 17). The 4 more decoys removed are raw WPA keys the generator labels as decoys (disclosed before the run).
|
|
40
|
+
- Kubernetes Secrets with several values are redacted whole (`kubernetes-secret-data` pass, #34 closed).
|
|
41
|
+
- All seven secret splits and `clean2` to `clean6` are spent. The evaluation's leak check removes invisible separators from stored text first (review 23). Remaining misses (round 6, seventh split): punctuation after a secret, CSV without a keyword, a keyword far from its value, Markdown notes, CI and rotation logs, spreadsheet shared strings.
|
|
42
|
+
- The table pass (`engine.table_secrets`) never ends a table on a guess; reviews 15 to 19 repros are in `tests/test_secret_rules_1[5-9].py`.
|
|
43
|
+
- **Sandbox:** deny by default. Workers open no user files and cannot see other processes; the parent hands each file over and checks the kernel's path for it (#7). Workers are split by kind and by tier; open-tier media workers share no GPU state (decision 0021). A scanner-only process scans open-bound and plugin output again, with line breaks as stored (#15, review 11). Escaped helpers are found by their working folder (inside the worker's private one) and killed (#17, review 12).
|
|
44
|
+
- **Hangs fail closed:** plugin loading (30 s), tier rules (2 s each, 120 s per sync), query embeddings (30 s), embedding batches (900 s), reranking (10 s; 30 s on the CPU) (#16, #21).
|
|
45
|
+
- **Tiers:** bound only what the MCP server returns. The threat model says so, and `mcp-setup` prints Claude Code deny rules.
|
|
46
|
+
- **Efficiency (phase 9):**
|
|
47
|
+
- 28 / 45 ms per search (35 / 49 ms through MCP);
|
|
48
|
+
- sync 55 s for 1,504 files with embeddings, about 1.5 s without;
|
|
49
|
+
- about 48 MB plus the model;
|
|
50
|
+
- with reranking (the default), 119 / 183 ms per search in-process, 123 / 182 ms through MCP (M5 Max); estimated over the 150 ms p50 budget at a million chunks;
|
|
51
|
+
- memory, counted as footprint (GPU included): embedder about 1.7 GB, reranker about 1.1 GB while loaded;
|
|
52
|
+
- every other budget met except: duplicates partly met; freshness partly met.
|
|
53
|
+
- **Reviews:** twenty-seven independent reviews (phases 2 to 9, the schema 8 vector store, two of the phase 9 fixes, the Linux sandbox, reranking, five of the 2026-10-03 secret rules, round 3's decoding views, round 4 with a follow-up, the ONNX search path, on 2026-10-07 round 3 again, the new extractors and the product features, and on 2026-10-08 the browser search, round 6 and the day's product features, each re-checked) found and fixed 60 P1 and 142 P2 defects. Review 11's P1s led to schema 9 (`files.read_tier`: a file is shown as open only if read on an open worker) and [decision 0021](docs/decisions/0021-open-media-shares-no-gpu-state.md) (open-tier media use Tesseract and the CPU).
|
|
54
|
+
- **Phase 9 also had:** a threat-model audit; a fresh-clone quickstart test; CI on macOS (python.org's Python cannot load SQLite extensions, so `[tool.uv] python-preference = "only-managed"`).
|
|
55
|
+
- **Prompt injection (#19, closed):** Claude Opus 5.5 with only lanternkb's tools saw 12 kinds of planted instruction 129 times in 24 sessions and followed none ([results](docs/results/injection.md)).
|
|
56
|
+
- **Open issues:** #29 (small table-pass gaps and leftovers, P3), #36 (a password after a few words: caught only by opt-in round 5, P2), #39 (calendars and contacts not indexed until the scanner covers them, P3).
|
|
57
|
+
- **Linux (2026-10-02):** semantic search through ONNX Runtime (#12, dev 0.838) and a Landlock + seccomp sandbox for workers (#10, `extract/linux_sandbox.py`), both checked in Linux CI.
|
|
58
|
+
- **Release checklist** ([roadmap](docs/roadmap.md)): every item that does not need the user passes, CI included.
|
|
59
|
+
- **Added on 2026-10-07 (autopilot):**
|
|
60
|
+
- file types: OpenDocument (`extractor.opendocument`), rich text, web pages as readable text, subtitles, about 40 more code and markup types; extractor `version` in manifests re-reads a changed feature's files; touching inline texts are separated by U+2063, which the scan reads as a space and a default join view reads joined;
|
|
61
|
+
- search filters (`types`, `modified_after`, `modified_before` in MCP; `--type`, `--since`, `--before` in the CLI), pushed into the vector search;
|
|
62
|
+
- `lanternkb setup`, a guided first run;
|
|
63
|
+
- ONNX query vectors in the MCP server (#35 closed);
|
|
64
|
+
- `scripts/check_ui_layout.py` (settings page at real phone widths), `scripts/ci_local.sh`;
|
|
65
|
+
- search ideas tried on dev and not pursued: `bench/search-ideas-log.md`.
|
|
66
|
+
- **Added on 2026-10-08 (autopilot, day 2):**
|
|
67
|
+
- **Search in the browser:** the settings page (`lanternkb ui`) has a search box.
|
|
68
|
+
- It searches every tier through the MCP server's own search; inside Claude Code, open files only.
|
|
69
|
+
- Queries go by POST, then a redirect to results kept under a random handle (Post/Redirect/Get), so they stay out of addresses, titles, history and the saved session.
|
|
70
|
+
- Matches are marked, and **Show in Finder** takes a result's id and path. Review 26 found no P1 and 2 P2s, fixed and re-checked.
|
|
71
|
+
- Design: [docs/lld/features-ui.md](docs/lld/features-ui.md), "Search on the settings page".
|
|
72
|
+
- **Terminal search** marks the query's words in bold. File text and names printed by `search`, `skipped` and `explain` lose control characters, so a file cannot send escape sequences to the terminal.
|
|
73
|
+
- **Result ids** carry a tag of the file's path (#37 closed).
|
|
74
|
+
- **Review 25 completed** (third look and verification):
|
|
75
|
+
- join-view windows keep whole lines (a P2 leak with line-anchored rules);
|
|
76
|
+
- a long run costs in proportion;
|
|
77
|
+
- windows never start inside a token;
|
|
78
|
+
- `ENGINE_VERSION` 16.
|
|
79
|
+
- **Round 6** (`scan.rules.ROUND6`; **on by default since the seventh test**, see Safety above):
|
|
80
|
+
- rules for `aws configure` transcripts, connection strings (ADO.NET, JDBC, libpq), exported and secret-named assignments, Wi-Fi keys, cloud-init, XML settings, LaTeX macros, Helm literals and FileZilla;
|
|
81
|
+
- LaTeX, prefix-wrap and emphasis views; Kubernetes Secrets in JSON (both kubectl copies);
|
|
82
|
+
- the vendored generic rule's short stopwords read as words in random-looking values.
|
|
83
|
+
- Review 27 found 2 P1s and 9 P2s before any test, all fixed.
|
|
84
|
+
- On spent splits it keeps 132 more of 6,114 out, with no new clean flags and 0 findings in 14,190 third-party files.
|
|
85
|
+
- Seventh held-out split: `test7`, seeds 9201–9204, `clean6` seed 8009; plan `bench/secrets7-plan.md`, used once.
|
|
86
|
+
- **Later on 2026-10-08 (after the owner's "keep going"):**
|
|
87
|
+
- **recent files:** a search for `*` (MCP, terminal, settings page) or `lanternkb recent` lists files newest first through the same tier and filter checks; MCP results carry `modified`;
|
|
88
|
+
- **sync progress:** a one-line counter on the terminal (TTY only) and the stage on the settings page; listeners hear counts, never paths;
|
|
89
|
+
- **a fresh-clone run** (independent agent, no P1) led to:
|
|
90
|
+
- suggested commands printed as the user would run them (`uv run`, `--config`; `lanternkb.hints`);
|
|
91
|
+
- unquoted multi-word queries;
|
|
92
|
+
- "No files skipped.";
|
|
93
|
+
- clearer deny-rule text;
|
|
94
|
+
- doc notes on the index folder and example-looking values;
|
|
95
|
+
- **#38 closed:** join-view findings widen on the text, so a glued token redacts only itself;
|
|
96
|
+
- **the join view again joins every separator in one reading** (a P2 its verification found: a secret split on both sides of punctuation);
|
|
97
|
+
- `ENGINE_VERSION` 19; development numbers unchanged on every spent split.
|
|
98
|
+
- **review 28** (recent files, hints, progress, UTF-16) found a P1:
|
|
99
|
+
- Text decoded as UTF-16 when the file mixes UTF-16 with other text (PowerShell `>>`) hid an ASCII secret as CJK characters.
|
|
100
|
+
- The worker now scans a NUL-stripped view of the raw bytes for text and code files with zero bytes or a UTF-16 BOM (`extract.worker.hidden_by_decoding`), and refuses the file (`mixed-encoding`) when that view holds a secret the decoded text does not show. This also closes the older BOM and UTF-8-head cases.
|
|
101
|
+
- Its P2 (recent files stalled on hidden files) is fixed with an mtime index, keyset paging and a 20,000-file cap.
|
|
102
|
+
- Its re-check found a P1 (the raw view kept CRLF) and two P2s (a duplicate hidden copy; keyset paging by path still sorted). All fixed: line breaks as scanned, a count comparison, paging by (time, row id). 1M files list in 0.1 ms.
|
|
103
|
+
- a count-only check of the Downloads folder (allowed 2026-10-03; [results](docs/results/real-files-1.md)): round 6 flags nothing new; calendars and contacts wait for scanner support (#39).
|
|
104
|
+
- **Owner decisions (2026-10-07):** 24-hour autopilot: expand features, support and fixes on first principles, quality first, without pausing; Colima may be installed for Linux tests (done); short status notes may be added to existing decision records.
|
|
105
|
+
- **Owner decisions (2026-10-03):** licence closed for now, to be thought through together; name `lanternkb` kept ([decision 0023](docs/decisions/0023-keep-the-name-lanternkb.md)); repo private for now; #19 may use Claude Code quota; real-file testing allowed on a few files (the Downloads folder), reporting aggregate numbers only.
|
|
106
|
+
- **Needs the user:** where (and whether) to post the announcement; real-file use on their own folders.
|
|
107
|
+
- **Tests:**
|
|
108
|
+
- `uv run pytest`: 1,104 fast, always with a temporary HOME and `CLAUDECODE` unset; slow tests are excluded by default (`addopts`).
|
|
109
|
+
- Slow: `LANTERNKB_MODELS_DIR=$PWD/data/cache/models uv run --all-extras pytest -m slow` (media, the adapters for QMD and grooveseek, the backtracking sweep, the real ONNX exports against references).
|
|
110
|
+
- Also: `scripts/check_licences.py` (with `--all-extras`), `scripts/audit_deps.sh` (SBOM and OSV), `scripts/scan_history.sh`, `scripts/check_secrets_regression.py` (`--split dev|test|test2|test3`) and `scripts/check_wheel.py` (the wheel ships no evaluation harness; `lanternkb-eval` comes from the dev-only `packages/lanternkb-dev`).
|
|
111
|
+
- CI: `.github/workflows/tests.yml` runs Linux on every push and macOS on demand (`gh workflow run tests.yml -f macos=true`). **GitHub Actions minutes ran out on 2026-10-07:** `scripts/ci_local.sh` runs the same checks on this machine (`mac`, `linux` in a Colima container from `scripts/ci/linux.Dockerfile`, `linux-onnx`); start the VM with `colima start` (it mounts only the repo and the job's scratch folder). Run it before every push.
|
|
112
|
+
- **Commit only after checking pytest's own exit code** (`rc=$?`), never through a `| tail` pipe.
|
|
113
|
+
- **Evaluation:** `./bench/run-phase5.sh dev|test`. For a re-measure that leaves the published tables alone, call `lanternkb.eval.runner.run_system` with a scratch `runs_dir`. The evaluation freezes the phase 1 identifier splitter (`text.split_identifier_v1`). Models live in `data/cache/models`.
|
|
114
|
+
- **Testing on this machine:**
|
|
115
|
+
- Every temporary config must set `index =`.
|
|
116
|
+
- Never launch a browser without `--use-mock-keychain --password-store=basic`.
|
|
117
|
+
- `tmutil` takes a second per call: the code writes the backup-exclusion attribute directly.
|
|
118
|
+
- The user wants **quality first** (keep independent reviews), and **real-file testing will come later**, when the user chooses; never before.
|
|
119
|
+
- **Decide routine questions yourself, and keep working without waiting** (user, 2026-10-01). Ask only when a decision changes the paradigm or a hard rule applies.
|
|
120
|
+
- **Next:** any further secret-rule change needs an eighth held-out split (fresh seeds; the generators' contexts are all known, so new contexts would need a new generator); any further search change needs a fourth held-out query set (no dev idea has cleared the 0.01 bar yet). Then phase 10 materials, unpublished (a draft announcement is in `docs/launch/`).
|
|
121
|
+
|
|
122
|
+
## What to do when the user says "go"
|
|
123
|
+
|
|
124
|
+
Work through the phases in [docs/roadmap.md](docs/roadmap.md), **in order and one at a time**, committing after each. Stop after phase 1 and report, because its outcome (decision 0004) may change the rest of the plan.
|
|
125
|
+
|
|
126
|
+
### Efficiency
|
|
127
|
+
|
|
128
|
+
- Default to Sonnet-class effort. Use a stronger model only for design decisions and for reviewing safety-critical code.
|
|
129
|
+
- Prefer scripts and tests over agents. Use at most **4 subagents** at once, only where the work is independent: for example, one arm of the bake-off per tool, and a separate agent that reproduces results from a fresh clone.
|
|
130
|
+
- Keep sessions short and commit often so nothing depends on a long context.
|
|
131
|
+
- Do not re-research what [docs/prior-art.md](docs/prior-art.md) already records; only update it.
|
|
132
|
+
|
|
133
|
+
### Hard rules
|
|
134
|
+
|
|
135
|
+
1. **Never read the user's real files.** Build and test on synthetic data. The user will run the real index. Do not open, list or summarise personal folders.
|
|
136
|
+
2. **No personal data in this repo or its history:** no real names, addresses, email addresses (other than the commit identity), machine names, home paths or documents. Fixtures are synthetic; fake secrets are labelled and allow-listed.
|
|
137
|
+
3. **No telemetry, no network calls in the core, no logging of document text, secrets or queries.**
|
|
138
|
+
4. **$0.** No paid services or data. Anything paid needs the user's explicit OK and must unlock something truly prestigious (hq decision 0002).
|
|
139
|
+
5. **The evaluation plan is fixed before running systems on the test split.** Report failures and nulls. Do not claim differences smaller than the spread.
|
|
140
|
+
6. **Do not post anywhere or create accounts** without the user's explicit OK. The repo is public and releases go out by tag (decision 0028); a new version still needs the owner's OK.
|
|
141
|
+
7. Log bugs as GitHub issues with a priority label (P1 / P2 / P3), written so a fresh session can pick them up.
|
|
142
|
+
|
|
143
|
+
### Stop and ask before
|
|
144
|
+
|
|
145
|
+
Indexing any real folder, granting or requesting macOS permissions, touching email or browser history, adding a shipped dependency that is not permissively licensed (no GPL, LGPL, AGPL, SSPL; see decision 0012), changing a decision record, or spending any money.
|
|
146
|
+
|
|
147
|
+
### When done (or when stopping at a gate)
|
|
148
|
+
|
|
149
|
+
- Update "Current state" here and the status line in `README.md`.
|
|
150
|
+
- Update the status and a short summary in `~/projects/hq/ideas/2026-09-local-knowledge-base.md` (hq is for writing things up, so editing that file is fine), then commit and push both repos.
|
|
151
|
+
- Give the user a short summary: what was done, what the measurements showed (including failures), and what needs a decision.
|
|
152
|
+
|
|
153
|
+
## Conventions
|
|
154
|
+
|
|
155
|
+
- Python with `uv`; `pyproject.toml` with a lockfile; `pytest` (fast tier: `uv run pytest`); Ruff. Type-annotate public interfaces.
|
|
156
|
+
- Third-party tools under evaluation run only with a throwaway `HOME` (`lanternkb.eval.measure.sandbox_env`), never against the user's home.
|
|
157
|
+
- Commit identity for this repo: `ankitb073`, `38665863+ankitb073@users.noreply.github.com`. Do not add attribution lines to commit messages or pull request descriptions.
|
|
158
|
+
- One short decision file per significant decision in `docs/decisions/` (context, decision, why).
|
|
159
|
+
- Numbers first, with dates and sources.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Code of conduct
|
|
2
|
+
|
|
3
|
+
lanternkb is a small project about privacy, so the first rule follows from that.
|
|
4
|
+
|
|
5
|
+
- **Respect people's privacy.** Never post someone's files, paths, credentials or personal details, theirs or yours, in issues, discussions or pull requests. Reproduce problems with synthetic data.
|
|
6
|
+
- **Be kind and specific.** Criticise code and claims, not people. Say what you measured and how.
|
|
7
|
+
- **No harassment** of any kind, in any project space or in private messages about the project.
|
|
8
|
+
- **Assume good faith,** and ask before concluding otherwise.
|
|
9
|
+
|
|
10
|
+
The maintainer may edit or remove anything that breaks these rules, and may block people who keep breaking them. To report a problem privately, use the contact in [SECURITY.md](SECURITY.md).
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
lanternkb is licensed under Apache-2.0. By submitting a contribution you license it under the same terms (Apache-2.0, section 5; [decision 0028](docs/decisions/0028-apache-2-and-public-release.md)). Plugins need no contribution: see [docs/plugins.md](docs/plugins.md).
|
|
4
|
+
|
|
5
|
+
## Ground rules
|
|
6
|
+
|
|
7
|
+
- Read [docs/threat-model.md](docs/threat-model.md) and the [decisions](docs/decisions/) first.
|
|
8
|
+
- Extensions go through the [extension API](docs/lld/extension-api.md) and pass its contract tests.
|
|
9
|
+
- Never add telemetry or network calls to the core. Never log document text, secrets or queries.
|
|
10
|
+
- Fixtures must be synthetic. Never commit real documents, personal paths or real credentials.
|
|
11
|
+
- Generate fake secrets at run time (see `tests/fakes.py`). A line that must hold a fake one carries a `# fake-secret: <why>` comment, which the repo's own scan (`scripts/scan_repo.py --history`) allow-lists. Committed results must hold repo-relative paths only.
|
|
12
|
+
- Claims about quality or safety need a measurement that others can reproduce. Report failures too.
|
|
13
|
+
- Every bug fix comes with a test that fails without it.
|
|
14
|
+
|
|
15
|
+
## Working on lanternkb
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
uv sync # development tools, the settings page, the example plugin
|
|
19
|
+
uv run pytest # the fast tier (about a minute)
|
|
20
|
+
uv run ruff check . && uv run ruff format --check src tests packages
|
|
21
|
+
LANTERNKB_MODELS_DIR=<folder with the models> uv run --all-extras pytest -m slow # OCR, audio
|
|
22
|
+
uv run --all-extras python scripts/check_licences.py # shipped dependencies are permissive
|
|
23
|
+
./scripts/audit_deps.sh # SBOM and known vulnerabilities (OSV)
|
|
24
|
+
./scripts/scan_history.sh # secrets and personal data in the whole history
|
|
25
|
+
uv run python scripts/check_secrets_regression.py # planted secrets still kept out (release)
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Things that bite:
|
|
29
|
+
- **Every config you write for a test or an experiment must set `index = "<temp folder>/index.db"`.** Without it lanternkb writes to `~/.local/share/lanternkb`. The test suite runs with a temporary `HOME`.
|
|
30
|
+
- **Never index a real folder** while developing. Build synthetic files in a temporary folder.
|
|
31
|
+
- Tests that check the macOS sandbox run only on macOS; CI runs Linux on every push and macOS on demand.
|
|
32
|
+
- A headless browser, if you ever need one, takes `--use-mock-keychain --password-store=basic` and a throwaway profile; otherwise macOS shows a blocking keychain dialog. The settings-page tests use `http.client` instead.
|
|
33
|
+
|
|
34
|
+
## Issues
|
|
35
|
+
|
|
36
|
+
Every bug is a GitHub issue with a priority label:
|
|
37
|
+
- **P1:** hurts users now (local-only text or a secret can leak, a restriction fails open).
|
|
38
|
+
- **P2:** soon, or a partial bypass.
|
|
39
|
+
- **P3:** polish.
|
|
40
|
+
|
|
41
|
+
Write it so someone with no context can pick it up: where, how to reproduce, why it matters, and a proposed fix.
|
lanternkb-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|