maskflow-sdk 0.1.0__py3-none-any.whl

maskflow/__init__.py

@@ -0,0 +1,13 @@
+from maskflow_core import Finding, MaskResult, PIIType, detect, mask, unmask
+
+from .sdk import mask_and_call
+
+__all__ = [
+    "detect",
+    "mask",
+    "unmask",
+    "mask_and_call",
+    "Finding",
+    "PIIType",
+    "MaskResult",
+]

maskflow/sdk.py

@@ -0,0 +1,23 @@
+from typing import Callable
+
+from maskflow_core import mask, unmask
+from maskflow_core.detection import DEFAULT_MIN_CONFIDENCE
+
+
+def mask_and_call(
+    prompt: str,
+    call_fn: Callable[[str], str],
+    min_confidence: float = DEFAULT_MIN_CONFIDENCE,
+) -> str:
+    """Mask PII in `prompt`, pass the masked text to `call_fn`, and restore the
+    original values in whatever `call_fn` returns.
+
+    `call_fn` is any function that takes a string and returns a string --
+    typically a closure around an LLM provider's client call. This makes
+    mask_and_call provider-agnostic: it works with Claude, OpenAI, Gemini, a
+    local model, or anything else, without MaskFlow depending on any
+    provider's SDK.
+    """
+    result = mask(prompt, min_confidence=min_confidence)
+    response = call_fn(result.masked_text)
+    return unmask(response, result.mapping)

maskflow_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: maskflow-sdk
+Version: 0.1.0
+Summary: Mask PII before it reaches an LLM, unmask the response. Works with any provider.
+License: MIT
+Requires-Python: >=3.9
+Requires-Dist: maskflow-core<0.2,>=0.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# maskflow
+
+Mask PII before it reaches an LLM. Unmask the response. Works with any provider.
+
+```python
+from maskflow import mask_and_call
+
+def call_claude(masked_prompt: str) -> str:
+    return anthropic_client.messages.create(
+        model="claude-sonnet-5",
+        max_tokens=1024,
+        messages=[{"role": "user", "content": masked_prompt}],
+    ).content[0].text
+
+response = mask_and_call(
+    "Hi, I'm Jane Doe (jane@example.com). My order shipped to 123 Main St but never arrived.",
+    call_claude,
+)
+# Claude only ever sees "Hi, I'm <PERSON_NAME_1> (<EMAIL_1>). My order shipped to
+# <ADDRESS_1> but never arrived." -- response comes back with the real values restored.
+```
+
+## Install
+
+```bash
+pip install maskflow-sdk
+```
+
+## Why this shape
+
+`mask_and_call` takes a plain function, not a specific provider's client. You write the one line
+that actually calls your LLM (Claude, OpenAI, Gemini, a local model, anything) -- maskflow never
+parses or depends on any provider's SDK, so it doesn't break when a provider changes their API and
+works with providers it's never heard of.
+
+```python
+response = mask_and_call(prompt, lambda masked: my_llm_client.generate(masked))
+```
+
+## Lower-level API
+
+For more control than the wrapper gives, `mask`/`unmask` are available directly and are pure,
+stateless functions -- no files, no database. Persisting the mapping between calls is your
+responsibility.
+
+```python
+from maskflow import mask, unmask
+
+result = mask("Email me at alice@example.com.")
+result.masked_text  # "Email me at <EMAIL_1>."
+result.mapping       # {"<EMAIL_1>": "alice@example.com"}
+
+unmask(result.masked_text, result.mapping)  # original text, restored
+```
+
+## What gets detected
+
+Email, phone, SSN, credit card, IP address, AWS access key, API key / generic secret, JWT, IBAN,
+street address, person name, date of birth -- via regex + structural validation (Luhn, mod-97,
+etc.) plus spaCy NER for names and dates, with keyword-context confidence boosting. See
+[`maskflow-core`](../../core) for detection internals.
+
+## Tests
+
+```bash
+uv run pytest
+```

maskflow_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+maskflow/__init__.py,sha256=Foc6txGSWkLcXiSge8bMN5GqmYfaLwuCDfWjNXqwHzs,233
+maskflow/sdk.py,sha256=c-bq8QLc8_n8VQlb1iOQ_XjaCh2Qsyh5RIFSrtQlCn8,859
+maskflow_sdk-0.1.0.dist-info/METADATA,sha256=IF_lyApnC8Pjqr1CObvd3WewRSehRfprdyBVbn05YZo,2406
+maskflow_sdk-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+maskflow_sdk-0.1.0.dist-info/RECORD,,

maskflow_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any