okf-core 0.3.0__tar.gz

okf_core-0.3.0/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/
+build/
+
+# Node / Next.js
+node_modules/
+.next/
+out/
+*.tsbuildinfo
+
+# Local derived bundle state (never committed; excluded from pack)
+.oknoll/
+
+# Terraform
+.terraform/
+*.tfstate
+*.tfstate.*
+*.tfvars
+!*.auto.tfvars.example
+crash.log
+
+# Environment / secrets
+.env
+.env.*
+!.env.example
+
+# OS / editor
+.DS_Store
+.idea/
+.vscode/

okf_core-0.3.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: okf-core
+Version: 0.3.0
+Summary: OpenKnoll core: CanonicalDoc, OKF v0.2 parser/writer, lint, pipeline, indexes, packer
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# okf-core
+
+OpenKnoll core library: the `CanonicalDoc` model, OKF v0.2 parser/writer,
+5-level lint, build pipeline (acquire → normalize → plan → generate → link →
+lint → index → publish), deterministic explorer, ask policy, RAG seam, and
+packer. Structurally network-free — real providers live in `oknoll-providers`.
+
+Usually consumed through the [`oknoll`](https://pypi.org/project/oknoll/) CLI.
+Part of [OpenKnoll](https://github.com/openknoll/oknoll-python).

okf_core-0.3.0/README.md

@@ -0,0 +1,9 @@
+# okf-core
+
+OpenKnoll core library: the `CanonicalDoc` model, OKF v0.2 parser/writer,
+5-level lint, build pipeline (acquire → normalize → plan → generate → link →
+lint → index → publish), deterministic explorer, ask policy, RAG seam, and
+packer. Structurally network-free — real providers live in `oknoll-providers`.
+
+Usually consumed through the [`oknoll`](https://pypi.org/project/oknoll/) CLI.
+Part of [OpenKnoll](https://github.com/openknoll/oknoll-python).

okf_core-0.3.0/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "okf-core"
+version = "0.3.0"
+description = "OpenKnoll core: CanonicalDoc, OKF v0.2 parser/writer, lint, pipeline, indexes, packer"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+readme = "README.md"
+dependencies = [
+    "pyyaml>=6.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/okf_core"]

okf_core-0.3.0/src/okf_core/__init__.py

@@ -0,0 +1,110 @@
+"""okf-core: CanonicalDoc, OKF v0.2 parser/writer, five-level lint, pipeline,
+revisions, packer.
+
+The heart of OpenKnoll — the CLI and the cloud pipeline job run this identical
+code.
+"""
+
+from okf_core._version import __version__
+from okf_core.ask import AskResult, Citation, answer_question, write_trace
+from okf_core.cache import BuildCache
+from okf_core.canonical import (
+    Anchor,
+    Block,
+    CanonicalDoc,
+    Link,
+    MediaRef,
+    SourceRef,
+    sha256_hex,
+)
+from okf_core.explorer import Explorer, ExplorerError
+from okf_core.findings import Finding, Level, LintReport, Severity
+from okf_core.frontmatter import (
+    KNOWN_KEY_ORDER,
+    STATUS_VALUES,
+    Frontmatter,
+    FrontmatterError,
+    FrontmatterShapeError,
+    FrontmatterYamlError,
+    ParsedDocument,
+    parse_document,
+    write_document,
+)
+from okf_core.indexing import build_link_graph, ensure_index, search_index, write_index
+from okf_core.lint import LintConfig, lint_bundle
+from okf_core.packer import PackResult, pack_bundle, strip_okf_fields
+from okf_core.pipeline import (
+    BuildOutcome,
+    PipelineError,
+    PipelineSource,
+    build_revision,
+    check_reproducibility,
+)
+from okf_core.provider import (
+    GENERATOR_VERSION,
+    ModelProvider,
+    StubModelProvider,
+    generation_cache_key,
+    resolve_provider,
+)
+from okf_core.rag import EmbeddingProvider, StubEmbeddingProvider, resolve_embedder
+from okf_core.revision import read_current_revision_id, revision_dir
+from okf_core.viz import build_graph, render_html, write_viz
+
+__all__ = [
+    "GENERATOR_VERSION",
+    "KNOWN_KEY_ORDER",
+    "STATUS_VALUES",
+    "Anchor",
+    "AskResult",
+    "Block",
+    "BuildCache",
+    "BuildOutcome",
+    "CanonicalDoc",
+    "Citation",
+    "EmbeddingProvider",
+    "Explorer",
+    "ExplorerError",
+    "Finding",
+    "Frontmatter",
+    "FrontmatterError",
+    "FrontmatterShapeError",
+    "FrontmatterYamlError",
+    "Level",
+    "Link",
+    "LintConfig",
+    "LintReport",
+    "MediaRef",
+    "ModelProvider",
+    "PackResult",
+    "ParsedDocument",
+    "PipelineError",
+    "PipelineSource",
+    "Severity",
+    "SourceRef",
+    "StubEmbeddingProvider",
+    "StubModelProvider",
+    "__version__",
+    "answer_question",
+    "build_graph",
+    "build_link_graph",
+    "build_revision",
+    "check_reproducibility",
+    "ensure_index",
+    "generation_cache_key",
+    "lint_bundle",
+    "pack_bundle",
+    "parse_document",
+    "read_current_revision_id",
+    "render_html",
+    "resolve_embedder",
+    "resolve_provider",
+    "revision_dir",
+    "search_index",
+    "sha256_hex",
+    "strip_okf_fields",
+    "write_document",
+    "write_index",
+    "write_trace",
+    "write_viz",
+]

okf_core-0.3.0/src/okf_core/_version.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"