ciphergate-cli 0.7.1__tar.gz → 0.8.0__tar.gz

{ciphergate_cli-0.7.1 → ciphergate_cli-0.8.0}/CHANGELOG.md

@@ -6,6 +6,15 @@ versioning: [PEP 440](https://peps.python.org/pep-0440/) with SemVer meaning (pr
 
 ## [Unreleased]
 
+## [0.8.0] - 2026-10-30
+
+Adds the packaged policy templates to the Python API. Existing behaviour is unchanged.
+
+### Added
+
+- Python API for the packaged policy templates: `load_template(name)` returns a `Policy` and
+  `template_names()` lists the names. An unknown name raises `UsageError`.
+
 ## [0.7.1] - 2026-10-30
 
 Makes the starter policy templates available after `pip install`. Existing commands and
@@ -270,7 +279,8 @@ Pre-release (alpha). Licensed under Apache-2.0. Not a final release: the securit
 See `docs/limitations.md`. Deferred: optional NER/Presidio detectors, stdin/stdout streaming,
 directory processing, structured log parsers, key files, reversible token vault, lossy decoding.
 
-[Unreleased]: https://github.com/aashishkumar-tech/ciphergate/compare/v0.7.1...HEAD
+[Unreleased]: https://github.com/aashishkumar-tech/ciphergate/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/aashishkumar-tech/ciphergate/compare/v0.7.1...v0.8.0
 [0.7.1]: https://github.com/aashishkumar-tech/ciphergate/compare/v0.7.0...v0.7.1
 [0.7.0]: https://github.com/aashishkumar-tech/ciphergate/compare/v0.6.1...v0.7.0
 [0.6.1]: https://github.com/aashishkumar-tech/ciphergate/compare/v0.6.0...v0.6.1

{ciphergate_cli-0.7.1 → ciphergate_cli-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: ciphergate-cli
-Version: 0.7.1
+Version: 0.8.0
 Summary: Local-first, environment- and destination-aware inspection and sanitization of logs and test datasets.
 Project-URL: Homepage, https://github.com/aashishkumar-tech/ciphergate
 Project-URL: Source, https://github.com/aashishkumar-tech/ciphergate
@@ -50,7 +50,7 @@ vendor ticket. CipherGate replaces that with a local, explainable, scriptable ga
 inspect  ->  plan  ->  sanitize --apply  ->  rescan
 ```
 
-> **Status: 0.7.1 (alpha).** No detector finds every sensitive value. A passing run means the
+> **Status: 0.8.0 (alpha).** No detector finds every sensitive value. A passing run means the
 > configured processing completed under the selected policy; it is **not** proof that the output
 > contains no sensitive information, and it is not a compliance (GDPR, HIPAA, PCI DSS, ...) or
 > anonymization guarantee. Policy templates must be reviewed before use.
@@ -494,6 +494,15 @@ report = sanitize_file("app.log", "app.clean.log", policy,
 print(report.status, report.exit_code)
 ```
 
+After `pip install`, there is no `policies/` folder. Load a packaged template by name instead;
+`template_names()` lists them. Templates require review for your data and destination.
+
+```python
+from ciphergate import load_template, template_names
+print(template_names())
+policy = load_template("developer_logs")
+```
+
 Streams and directories use the same pipeline and the same safety rules as the CLI:
 
 ```python

{ciphergate_cli-0.7.1 → ciphergate_cli-0.8.0}/README.md

@@ -11,7 +11,7 @@ vendor ticket. CipherGate replaces that with a local, explainable, scriptable ga
 inspect  ->  plan  ->  sanitize --apply  ->  rescan
 ```
 
-> **Status: 0.7.1 (alpha).** No detector finds every sensitive value. A passing run means the
+> **Status: 0.8.0 (alpha).** No detector finds every sensitive value. A passing run means the
 > configured processing completed under the selected policy; it is **not** proof that the output
 > contains no sensitive information, and it is not a compliance (GDPR, HIPAA, PCI DSS, ...) or
 > anonymization guarantee. Policy templates must be reviewed before use.
@@ -455,6 +455,15 @@ report = sanitize_file("app.log", "app.clean.log", policy,
 print(report.status, report.exit_code)
 ```
 
+After `pip install`, there is no `policies/` folder. Load a packaged template by name instead;
+`template_names()` lists them. Templates require review for your data and destination.
+
+```python
+from ciphergate import load_template, template_names
+print(template_names())
+policy = load_template("developer_logs")
+```
+
 Streams and directories use the same pipeline and the same safety rules as the CLI:
 
 ```python

{ciphergate_cli-0.7.1 → ciphergate_cli-0.8.0}/src/ciphergate/__init__.py

@@ -3,6 +3,8 @@
 Supported public API (everything else is internal and may change without notice)::
 
     load_policy(path) -> Policy
+    load_template(name) -> Policy        # a packaged template; review it before relying on it
+    template_names() -> list[str]
     validate_policy(path_or_policy) -> ValidationResult
     inspect_file(path, policy, context=None) -> RunReport
     plan_file(path, policy, context=None) -> RunReport
@@ -22,7 +24,7 @@ Supported public API (everything else is internal and may change without notice)
     rescan_directory(root, policy, context=None, *, recursive=False, strict=None) -> BatchReport
 """
 
-__version__ = "0.7.1"
+__version__ = "0.8.0"
 
 from ciphergate.config import RuntimeSettings
 from ciphergate.constants import (
@@ -55,6 +57,7 @@ from ciphergate.pipeline.streams import (
     rescan_stream,
     sanitize_stream,
 )
+from ciphergate.policy.templates import load_template, template_names
 from ciphergate.policy.validator import (
     Policy,
     ValidationResult,
@@ -82,6 +85,7 @@ __all__ = [
     "inspect_file",
     "inspect_stream",
     "load_policy",
+    "load_template",
     "plan_directory",
     "plan_file",
     "plan_stream",
@@ -91,5 +95,6 @@ __all__ = [
     "sanitize_directory",
     "sanitize_file",
     "sanitize_stream",
+    "template_names",
     "validate_policy",
 ]

{ciphergate_cli-0.7.1 → ciphergate_cli-0.8.0}/src/ciphergate/policy/templates.py

@@ -7,6 +7,7 @@ from importlib.resources.abc import Traversable
 from pathlib import Path
 
 from ciphergate.errors import UsageError
+from ciphergate.policy.validator import Policy, load_policy_text
 
 
 def _templates_dir() -> Traversable:
@@ -34,3 +35,8 @@ def read_template(name: str) -> str:
             code="unknown_policy_template",
         )
     return _templates_dir().joinpath(f"{name}.yml").read_text(encoding="utf-8")
+
+
+def load_template(name: str) -> Policy:
+    """Load a named template as a `Policy`. It is a starting point that requires review."""
+    return load_policy_text(read_template(name), source_name=f"{name}.yml")

ciphergate_cli-0.8.0/tests/unit/test_policy_templates.py

@@ -0,0 +1,55 @@
+"""Packaged policy templates through the public Python API."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import pytest
+
+import ciphergate
+from ciphergate import (
+    ContextInput,
+    RunStatus,
+    load_policy,
+    load_template,
+    sanitize_file,
+    template_names,
+)
+from ciphergate.errors import CipherGateError, UsageError
+from tests.conftest import EXAMPLES, POLICIES
+
+
+def test_public_exports() -> None:
+    for name in ("load_template", "template_names"):
+        assert name in ciphergate.__all__ and hasattr(ciphergate, name)
+
+
+def test_names_match_the_policy_files() -> None:
+    assert template_names() == sorted(p.stem for p in POLICIES.glob("*.yml"))
+
+
+@pytest.mark.parametrize("name", template_names())
+def test_load_template_matches_the_policy_file(name: str) -> None:
+    policy = load_template(name)
+    assert policy.name == load_policy(POLICIES / f"{name}.yml").name
+    assert policy.source_name == f"{name}.yml"
+
+
+@pytest.mark.parametrize("name", ["nope", "../pyproject", "dev_local.yml", ""])
+def test_unknown_template_is_rejected(name: str) -> None:
+    with pytest.raises(UsageError) as err:
+        load_template(name)
+    assert err.value.code == "unknown_policy_template"
+    assert isinstance(err.value, CipherGateError)
+
+
+def test_loaded_template_still_blocks_and_publishes_nothing(tmp_path: Path) -> None:
+    output = tmp_path / "out.log"
+    report = sanitize_file(
+        EXAMPLES / "sample.log",
+        output,
+        load_template("prd_external_ai"),
+        ContextInput(),
+    )
+    assert report.status == RunStatus.BLOCKED and report.exit_code == 1
+    assert not output.exists()