quba-sensitive-data-protection 0.0.8__tar.gz

quba_sensitive_data_protection-0.0.8/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.3
+Name: quba-sensitive-data-protection
+Version: 0.0.8
+Summary: A client library for accessing Sensitive Data Protection API
+Requires-Dist: httpx>=0.23.1,<0.29.0
+Requires-Dist: attrs>=22.2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# quba-sensitive-data-protection
+
+A client library for accessing Sensitive Data Protection API — a Python client for detecting and de-identifying
+sensitive data (PII) in text: **scan** for entities (emails, names, phone
+numbers, …) and **anonymize** them with configurable rules (redact, mask,
+replace, hash, encrypt).
+
+## Installation
+
+```bash
+pip install quba-sensitive-data-protection
+# or
+uv add quba-sensitive-data-protection
+```
+
+## Quickstart
+
+```python
+from quba_sdp import Client, models
+from quba_sdp.api import scan_text, anonymize_text
+
+client = Client()  # defaults to the production API; pass base_url=... to override
+
+# --- scan: locate sensitive entities ---
+resp = scan_text.sync(client=client, body=models.ScanRequestBody(text="Email me at a@b.com"))
+if isinstance(resp, models.ScanResponseBody):
+    for r in resp.results:
+        print(r.entity_type, r.start, r.end, r.score)
+
+# --- anonymize: transform matches ---
+body = models.AnonymizeRequestBody(
+    text="Email me at a@b.com",
+    rules=[
+        models.MaskRule(entities=[models.ModelEntity(value="email")], masking_char="*"),
+    ],
+)
+result = anonymize_text.sync(client=client, body=body)
+if isinstance(result, models.AnonymizeResponseBody):
+    print(result.text)  # 'Email me at ***********'
+```
+
+## Base URL
+
+`Client()` targets the production API by default. Override it for local or
+staging:
+
+```python
+client = Client(base_url="http://localhost:8000")
+```
+
+## Authentication
+
+The production API requires a token — use `AuthenticatedClient` (it shares the
+same default base URL):
+
+```python
+from quba_sdp import AuthenticatedClient
+
+client = AuthenticatedClient(token="SuperSecretToken")
+```
+
+## Calling endpoints
+
+Every operation lives in a module under `quba_sdp.api` and exposes four
+functions:
+
+| function | blocking | returns |
+| --- | --- | --- |
+| `sync` | ✅ | parsed body, or `None` for an undocumented/error status |
+| `sync_detailed` | ✅ | `Response[...]` with `.status_code`, `.headers`, `.parsed` |
+| `asyncio` | — | like `sync`, awaitable |
+| `asyncio_detailed` | — | like `sync_detailed`, awaitable |
+
+`sync` returns a **union** of the success body and any documented error (e.g.
+`HTTPValidationError`), so narrow it before use:
+
+```python
+r = scan_text.sync(client=client, body=...)
+if isinstance(r, models.ScanResponseBody):
+    ...  # success
+else:
+    ...  # HTTPValidationError or None
+```
+
+Async variant:
+
+```python
+async with Client() as client:
+    resp = await scan_text.asyncio(client=client, body=models.ScanRequestBody(text="..."))
+```
+
+## Advanced configuration
+
+`Client` / `AuthenticatedClient` accept `timeout=`, `verify_ssl=`, `headers=`,
+`cookies=`, and `httpx_args=` for full control of the underlying `httpx` client
+(see the `Client` docstring). Disabling TLS verification is a security risk:
+
+```python
+client = Client(verify_ssl=False)  # not recommended
+```

quba_sensitive_data_protection-0.0.8/README.md

@@ -0,0 +1,100 @@
+# quba-sensitive-data-protection
+
+A client library for accessing Sensitive Data Protection API — a Python client for detecting and de-identifying
+sensitive data (PII) in text: **scan** for entities (emails, names, phone
+numbers, …) and **anonymize** them with configurable rules (redact, mask,
+replace, hash, encrypt).
+
+## Installation
+
+```bash
+pip install quba-sensitive-data-protection
+# or
+uv add quba-sensitive-data-protection
+```
+
+## Quickstart
+
+```python
+from quba_sdp import Client, models
+from quba_sdp.api import scan_text, anonymize_text
+
+client = Client()  # defaults to the production API; pass base_url=... to override
+
+# --- scan: locate sensitive entities ---
+resp = scan_text.sync(client=client, body=models.ScanRequestBody(text="Email me at a@b.com"))
+if isinstance(resp, models.ScanResponseBody):
+    for r in resp.results:
+        print(r.entity_type, r.start, r.end, r.score)
+
+# --- anonymize: transform matches ---
+body = models.AnonymizeRequestBody(
+    text="Email me at a@b.com",
+    rules=[
+        models.MaskRule(entities=[models.ModelEntity(value="email")], masking_char="*"),
+    ],
+)
+result = anonymize_text.sync(client=client, body=body)
+if isinstance(result, models.AnonymizeResponseBody):
+    print(result.text)  # 'Email me at ***********'
+```
+
+## Base URL
+
+`Client()` targets the production API by default. Override it for local or
+staging:
+
+```python
+client = Client(base_url="http://localhost:8000")
+```
+
+## Authentication
+
+The production API requires a token — use `AuthenticatedClient` (it shares the
+same default base URL):
+
+```python
+from quba_sdp import AuthenticatedClient
+
+client = AuthenticatedClient(token="SuperSecretToken")
+```
+
+## Calling endpoints
+
+Every operation lives in a module under `quba_sdp.api` and exposes four
+functions:
+
+| function | blocking | returns |
+| --- | --- | --- |
+| `sync` | ✅ | parsed body, or `None` for an undocumented/error status |
+| `sync_detailed` | ✅ | `Response[...]` with `.status_code`, `.headers`, `.parsed` |
+| `asyncio` | — | like `sync`, awaitable |
+| `asyncio_detailed` | — | like `sync_detailed`, awaitable |
+
+`sync` returns a **union** of the success body and any documented error (e.g.
+`HTTPValidationError`), so narrow it before use:
+
+```python
+r = scan_text.sync(client=client, body=...)
+if isinstance(r, models.ScanResponseBody):
+    ...  # success
+else:
+    ...  # HTTPValidationError or None
+```
+
+Async variant:
+
+```python
+async with Client() as client:
+    resp = await scan_text.asyncio(client=client, body=models.ScanRequestBody(text="..."))
+```
+
+## Advanced configuration
+
+`Client` / `AuthenticatedClient` accept `timeout=`, `verify_ssl=`, `headers=`,
+`cookies=`, and `httpx_args=` for full control of the underlying `httpx` client
+(see the `Client` docstring). Disabling TLS verification is a security risk:
+
+```python
+client = Client(verify_ssl=False)  # not recommended
+```

quba_sensitive_data_protection-0.0.8/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "quba-sensitive-data-protection"
+version = "0.0.8"
+description = "A client library for accessing Sensitive Data Protection API"
+authors = []
+requires-python = ">=3.11"
+readme = "README.md"
+dependencies = [
+    "httpx>=0.23.1,<0.29.0",
+    "attrs>=22.2.0",
+]
+
+[tool.uv.build-backend]
+module-name = "quba_sdp"
+module-root = ""
+
+[build-system]
+requires = ["uv_build>=0.11.0,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["F", "I", "UP"]

quba_sensitive_data_protection-0.0.8/quba_sdp/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Sensitive Data Protection API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

quba_sensitive_data_protection-0.0.8/quba_sdp/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

quba_sensitive_data_protection-0.0.8/quba_sdp/api/anonymize_text.py

@@ -0,0 +1,206 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from .. import errors
+from ..client import AuthenticatedClient, Client
+from ..models.anonymize_request_body import AnonymizeRequestBody
+from ..models.anonymize_response_body import AnonymizeResponseBody
+from ..models.http_validation_error import HTTPValidationError
+from ..types import Response
+
+
+def _get_kwargs(
+    *,
+    body: AnonymizeRequestBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/anonymize",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AnonymizeResponseBody | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = AnonymizeResponseBody.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AnonymizeResponseBody | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> Response[AnonymizeResponseBody | HTTPValidationError]:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AnonymizeResponseBody | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> AnonymizeResponseBody | HTTPValidationError | None:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AnonymizeResponseBody | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> Response[AnonymizeResponseBody | HTTPValidationError]:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AnonymizeResponseBody | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> AnonymizeResponseBody | HTTPValidationError | None:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AnonymizeResponseBody | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

quba_sensitive_data_protection-0.0.8/quba_sdp/api/health_check.py

@@ -0,0 +1,142 @@
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from .. import errors
+from ..client import AuthenticatedClient, Client
+from ..types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/health",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> str | None:
+    if response.status_code == 200:
+        response_200 = cast(str, response.json())
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[str]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[str]:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[str]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+) -> str | None:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        str
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[str]:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[str]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+) -> str | None:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        str
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed