okf-cli 0.1.0__tar.gz → 0.1.2__tar.gz

{okf_cli-0.1.0 → okf_cli-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: okf-cli
-Version: 0.1.0
+Version: 0.1.2
 Summary: Open Knowledge Format tooling
 License: MIT License
         
@@ -30,17 +30,29 @@ Description-Content-Type: text/markdown
 
 # okf-cli — Open Knowledge Format tooling
 
-Converts plain markdown into [OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)-conformant knowledge bundles. Domain experts write `# Title` then `> description` — `okf enrich` generates frontmatter, type, timestamps, and index files.
+Converts plain markdown into [OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)-conformant knowledge bundles. Domain experts write `# Title` then `> description` — `okf bundle` generates frontmatter, type, timestamps, and index files.
 
-## Quickstart
+## Install
 
 ```bash
-uv sync
-uv run okf example              # output → bundled/
+uv tool install okf-cli
+```
+
+Then run:
+
+```bash
+okf bundle example              # output → bundled/
 cat bundled/index.md
 cat bundled/tables/orders.md
 ```
 
+### Dev quickstart
+
+```bash
+uv sync
+uv run okf example
+```
+
 ## Usage
 
 ```

{okf_cli-0.1.0 → okf_cli-0.1.2}/README.md

@@ -1,16 +1,28 @@
 # okf-cli — Open Knowledge Format tooling
 
-Converts plain markdown into [OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)-conformant knowledge bundles. Domain experts write `# Title` then `> description` — `okf enrich` generates frontmatter, type, timestamps, and index files.
+Converts plain markdown into [OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)-conformant knowledge bundles. Domain experts write `# Title` then `> description` — `okf bundle` generates frontmatter, type, timestamps, and index files.
 
-## Quickstart
+## Install
 
 ```bash
-uv sync
-uv run okf example              # output → bundled/
+uv tool install okf-cli
+```
+
+Then run:
+
+```bash
+okf bundle example              # output → bundled/
 cat bundled/index.md
 cat bundled/tables/orders.md
 ```
 
+### Dev quickstart
+
+```bash
+uv sync
+uv run okf example
+```
+
 ## Usage
 
 ```

{okf_cli-0.1.0 → okf_cli-0.1.2}/example/README.md

@@ -1,12 +1,12 @@
 # OKF Example
 
 This directory contains plain markdown files written by domain experts.
-Run `okf enrich` to convert them into an OKF-conformant knowledge bundle.
+Run `okf bundle` to convert them into an OKF-conformant knowledge bundle.
 
 ```bash
 # From repo root:
-uv run okf example output-bundle
+uv run okf bundle example output-bundle
 
 # With a default type for root-level files (if any):
-uv run okf example output-bundle --default-type reference
+uv run okf bundle example output-bundle --default-type reference
 ```

{okf_cli-0.1.0 → okf_cli-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "okf-cli"
-version = "0.1.0"
+version = "0.1.2"
 description = "Open Knowledge Format tooling"
 readme = "README.md"
 license = { file = "LICENSE" }

{okf_cli-0.1.0 → okf_cli-0.1.2}/src/okf/cli.py

@@ -1,4 +1,4 @@
-"""okf enrich — Plain markdown to OKF bundle converter."""
+"""okf bundle — Plain markdown to OKF bundle converter."""
 
 import json
 import os
@@ -14,6 +14,13 @@ app = typer.Typer(
     no_args_is_help=True,
 )
 
+
+@app.callback()
+def main() -> None:
+    """Convert plain markdown into OKF-conformant knowledge bundles."""
+    pass
+
+
 RESERVED = frozenset({"index.md", "log.md", "readme.md"})
 
 
@@ -78,7 +85,7 @@ def _parse_md(text: str) -> tuple[str, str, str]:
 
 
 @app.command()
-def enrich(
+def bundle(
     input_dir: str = typer.Argument(
         ..., help="Source directory of plain markdown files"
     ),

{okf_cli-0.1.0 → okf_cli-0.1.2}/tests/test_cli.py

@@ -1,4 +1,4 @@
-"""Tests for okf enrich CLI."""
+"""Tests for okf bundle CLI."""
 
 import json
 from pathlib import Path
@@ -113,7 +113,7 @@ def _write_fixture(dir: Path, files: dict[str, str]):
         p.write_text(content)
 
 
-def test_enrich_basic(tmp_path: Path):
+def test_bundle_basic(tmp_path: Path):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -125,7 +125,7 @@ def test_enrich_basic(tmp_path: Path):
         },
     )
 
-    result = runner.invoke(app, [str(src), str(dst)])
+    result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
 
     # Check output structure
@@ -150,7 +150,7 @@ def test_enrich_basic(tmp_path: Path):
     assert "[tables](tables/)" in root_idx
 
 
-def test_enrich_root_file_with_default_type(tmp_path: Path):
+def test_bundle_root_file_with_default_type(tmp_path: Path):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -162,7 +162,7 @@ def test_enrich_root_file_with_default_type(tmp_path: Path):
         },
     )
 
-    result = runner.invoke(app, [str(src), str(dst), "--default-type", "reference"])
+    result = runner.invoke(app, ["bundle", str(src), str(dst), "--default-type", "reference"])
     assert result.exit_code == 0, result.output
 
     stand = (dst / "standalone.md").read_text()
@@ -177,7 +177,7 @@ def test_enrich_root_file_with_default_type(tmp_path: Path):
     assert "[Standalone](standalone.md)" in root_idx
 
 
-def test_enrich_skip_root_file_without_default(tmp_path: Path, capsys):
+def test_bundle_skip_root_file_without_default(tmp_path: Path, capsys):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -189,7 +189,7 @@ def test_enrich_skip_root_file_without_default(tmp_path: Path, capsys):
         },
     )
 
-    result = runner.invoke(app, [str(src), str(dst)])
+    result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
 
     assert not (dst / "standalone.md").exists()
@@ -202,7 +202,7 @@ def test_enrich_skip_root_file_without_default(tmp_path: Path, capsys):
     assert "[Standalone" not in root_idx
 
 
-def test_enrich_validation_error(tmp_path: Path):
+def test_bundle_validation_error(tmp_path: Path):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -213,12 +213,12 @@ def test_enrich_validation_error(tmp_path: Path):
         },
     )
 
-    result = runner.invoke(app, [str(src), str(dst)])
+    result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 1
     assert "Line 1 must be" in result.output
 
 
-def test_enrich_replaces_existing_output(tmp_path: Path):
+def test_bundle_replaces_existing_output(tmp_path: Path):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -226,26 +226,26 @@ def test_enrich_replaces_existing_output(tmp_path: Path):
     (dst / "leftover.txt").write_text("should be gone")
     _write_fixture(src, {"tables/a.md": "# A\n\n> Desc.\n"})
 
-    result = runner.invoke(app, [str(src), str(dst)])
+    result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
     assert "Removed existing" in result.output
     assert (dst / "tables" / "a.md").exists()
     assert not (dst / "leftover.txt").exists()
 
 
-def test_enrich_no_md_files(tmp_path: Path):
+def test_bundle_no_md_files(tmp_path: Path):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
     # Create a non-md file
     (src / "readme.txt").write_text("hello")
 
-    result = runner.invoke(app, [str(src), str(dst)])
+    result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 1
     assert "No markdown files" in result.output
 
 
-def test_enrich_logmd_warning(tmp_path: Path):
+def test_bundle_logmd_warning(tmp_path: Path):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -253,7 +253,7 @@ def test_enrich_logmd_warning(tmp_path: Path):
     (src / "tables").mkdir()
     (src / "tables/orders.md").write_text("# Orders\n\n> One row.\n\nBody.")
 
-    result = runner.invoke(app, [str(src), str(dst)])
+    result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
     assert "reserved filename" in result.output
     assert "log.md" in result.output
@@ -261,7 +261,7 @@ def test_enrich_logmd_warning(tmp_path: Path):
     assert (dst / "tables" / "orders.md").exists()
 
 
-def test_enrich_readme_is_reserved(tmp_path: Path):
+def test_bundle_readme_is_reserved(tmp_path: Path):
     """README.md is reserved and skipped."""
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
@@ -274,7 +274,7 @@ def test_enrich_readme_is_reserved(tmp_path: Path):
         "# Orders\n\n> One row.\n\nBody."
     )
 
-    result = runner.invoke(app, [str(src), str(dst)])
+    result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
     assert not (dst / "tables" / "README.md").exists()
     assert (dst / "tables" / "orders.md").exists()
@@ -291,7 +291,7 @@ def test_frontmatter_yaml_parseable(tmp_path: Path):
         "# True/False\n\n> Yes, no, true, false values\n\nBody."
     )
 
-    result = runner.invoke(app, [str(src), str(dst), "--default-type", "ref"])
+    result = runner.invoke(app, ["bundle", str(src), str(dst), "--default-type", "ref"])
     assert result.exit_code == 0, result.output
 
     content = (dst / "data.md").read_text()

{okf_cli-0.1.0 → okf_cli-0.1.2}/uv.lock

@@ -52,7 +52,7 @@ wheels = [
 
 [[package]]
 name = "okf-cli"
-version = "0.1.0"
+version = "0.1.1"
 source = { editable = "." }
 dependencies = [
     { name = "typer" },