hush-hush 1.2.3__tar.gz

hush_hush-1.2.3/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: hush-hush
+Version: 1.2.3
+Summary: Official Python SDK for hush-hush, generated from its OpenAPI spec
+Author: alrayyes
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: httpx==0.28.1
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/alrayyes/hush-hush-python
+Project-URL: Repository, https://github.com/alrayyes/hush-hush-python
+Description-Content-Type: text/markdown
+
+# hush-hush-python
+
+[![ci](https://github.com/alrayyes/hush-hush-python/actions/workflows/ci.yml/badge.svg)](https://github.com/alrayyes/hush-hush-python/actions/workflows/ci.yml)
+[![Codecov](https://codecov.io/gh/alrayyes/hush-hush-python/graph/badge.svg)](https://codecov.io/gh/alrayyes/hush-hush-python)
+[![PyPI](https://img.shields.io/pypi/v/hush-hush)](https://pypi.org/project/hush-hush/)
+[![release](https://img.shields.io/github/v/release/alrayyes/hush-hush-python)](https://github.com/alrayyes/hush-hush-python/releases)
+[![license](https://img.shields.io/github/license/alrayyes/hush-hush-python)](LICENSE)
+
+The official Python SDK for [hush-hush](https://github.com/alrayyes/hush-hush),
+generated from its OpenAPI spec and kept in sync with it automatically.
+
+## Install
+
+```sh
+pip install hush-hush
+```
+
+Requires Python 3.11 or newer.
+
+## Quickstart
+
+```python
+from hush_hush import Client
+
+client = Client("https://hush-hush.example.com", api_key="your-api-key")  # or set HUSH_HUSH_API_KEY
+
+# Create is a write operation — it needs the credential above.
+client.create_object("my-first-secret", b"already-sealed-ciphertext")
+
+# Get needs no credential — hush-hush's confidentiality boundary is
+# "who holds a matching private key," not who's calling this endpoint.
+value = client.get_object("my-first-secret")
+print(f"got {len(value)} bytes of sealed ciphertext")
+
+# The audit log records every read and write; querying it needs no
+# credential either, and returns the full matching result set (there's
+# no pagination on this endpoint).
+for entry in client.query_audit_log():
+    print(entry.action, entry.object_id, entry.timestamp)
+```
+
+An `AsyncClient` with the same methods (`await client.get_object(...)`) is
+available for async code. The API key is only required for write operations
+(create/update/delete); reads (get, used-by, audit-log query) work without
+one. `caller`, accepted by most methods, is optional. See the
+[full API reference](https://alrayyes.github.io/hush-hush-python/) for
+everything else.
+
+## Versioning
+
+This SDK's version tracks hush-hush's OpenAPI spec, not this repo's own
+commit history — see [CONTRIBUTING.md](CONTRIBUTING.md) for how a spec
+change becomes a release.
+
+## License
+
+[MIT](LICENSE)

hush_hush-1.2.3/README.md

@@ -0,0 +1,57 @@
+# hush-hush-python
+
+[![ci](https://github.com/alrayyes/hush-hush-python/actions/workflows/ci.yml/badge.svg)](https://github.com/alrayyes/hush-hush-python/actions/workflows/ci.yml)
+[![Codecov](https://codecov.io/gh/alrayyes/hush-hush-python/graph/badge.svg)](https://codecov.io/gh/alrayyes/hush-hush-python)
+[![PyPI](https://img.shields.io/pypi/v/hush-hush)](https://pypi.org/project/hush-hush/)
+[![release](https://img.shields.io/github/v/release/alrayyes/hush-hush-python)](https://github.com/alrayyes/hush-hush-python/releases)
+[![license](https://img.shields.io/github/license/alrayyes/hush-hush-python)](LICENSE)
+
+The official Python SDK for [hush-hush](https://github.com/alrayyes/hush-hush),
+generated from its OpenAPI spec and kept in sync with it automatically.
+
+## Install
+
+```sh
+pip install hush-hush
+```
+
+Requires Python 3.11 or newer.
+
+## Quickstart
+
+```python
+from hush_hush import Client
+
+client = Client("https://hush-hush.example.com", api_key="your-api-key")  # or set HUSH_HUSH_API_KEY
+
+# Create is a write operation — it needs the credential above.
+client.create_object("my-first-secret", b"already-sealed-ciphertext")
+
+# Get needs no credential — hush-hush's confidentiality boundary is
+# "who holds a matching private key," not who's calling this endpoint.
+value = client.get_object("my-first-secret")
+print(f"got {len(value)} bytes of sealed ciphertext")
+
+# The audit log records every read and write; querying it needs no
+# credential either, and returns the full matching result set (there's
+# no pagination on this endpoint).
+for entry in client.query_audit_log():
+    print(entry.action, entry.object_id, entry.timestamp)
+```
+
+An `AsyncClient` with the same methods (`await client.get_object(...)`) is
+available for async code. The API key is only required for write operations
+(create/update/delete); reads (get, used-by, audit-log query) work without
+one. `caller`, accepted by most methods, is optional. See the
+[full API reference](https://alrayyes.github.io/hush-hush-python/) for
+everything else.
+
+## Versioning
+
+This SDK's version tracks hush-hush's OpenAPI spec, not this repo's own
+commit history — see [CONTRIBUTING.md](CONTRIBUTING.md) for how a spec
+change becomes a release.
+
+## License
+
+[MIT](LICENSE)

hush_hush-1.2.3/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+build-backend = "uv_build"
+requires = ["uv-build>=0.12.5,<0.13"]
+
+[project]
+name = "hush-hush"
+version = "1.2.3"
+description = "Official Python SDK for hush-hush, generated from its OpenAPI spec"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = ["httpx==0.28.1"]
+
+[[project.authors]]
+name = "alrayyes"
+
+[project.urls]
+Homepage = "https://github.com/alrayyes/hush-hush-python"
+Repository = "https://github.com/alrayyes/hush-hush-python"
+
+[dependency-groups]
+dev = [
+    "openapi-python-client==0.29.0",
+    "pact-python==3.4.0",
+    "pip-audit==2.10.1",
+    "pytest==9.1.1",
+    "pytest-asyncio==1.4.0",
+    "pytest-cov==7.1.0",
+    "ruff==0.16.5",
+]
+docs = [
+    "mkdocs==1.6.1",
+    "mkdocs-material==9.7.7",
+    "mkdocstrings[python]==1.0.6",
+]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+extend-exclude = ["src/hush_hush/_generated"]
+
+[tool.ruff.format]
+indent-style = "space"
+quote-style = "double"
+
+[tool.ruff.lint]
+select = [
+    "B",
+    "C4",
+    "E",
+    "F",
+    "I",
+    "N",
+    "SIM",
+    "UP",
+    "W",
+]
+ignore = ["E501"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/conftest.py" = ["N815"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["hush_hush"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-m 'not contract and not pact and not e2e'"
+markers = [
+    "contract: runs against a local Prism mock, needs HUSH_HUSH_BASE_URL",
+    "e2e: runs against a real staging hush-hush, needs HUSH_HUSH_BASE_URL/HUSH_HUSH_API_KEY",
+    "pact: records a Pact consumer contract, needs the pact native library",
+]
+asyncio_mode = "auto"

hush_hush-1.2.3/pyproject.toml.orig

@@ -0,0 +1,72 @@
+[build-system]
+build-backend = "uv_build"
+requires = [ "uv-build>=0.12.5,<0.13" ]
+
+[project]
+name = "hush-hush"
+version = "1.2.3"
+description = "Official Python SDK for hush-hush, generated from its OpenAPI spec"
+readme = "README.md"
+license = "MIT"
+authors = [ { name = "alrayyes" } ]
+requires-python = ">=3.11"
+classifiers = [
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+]
+dependencies = [ "httpx==0.28.1" ]
+urls.Homepage = "https://github.com/alrayyes/hush-hush-python"
+urls.Repository = "https://github.com/alrayyes/hush-hush-python"
+
+[dependency-groups]
+dev = [
+  "openapi-python-client==0.29.0",
+  "pact-python==3.4.0",
+  "pip-audit==2.10.1",
+  "pytest==9.1.1",
+  "pytest-asyncio==1.4.0",
+  "pytest-cov==7.1.0",
+  "ruff==0.16.5",
+]
+docs = [ "mkdocs==1.6.1", "mkdocs-material==9.7.7", "mkdocstrings[python]==1.0.6" ]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+extend-exclude = [ "src/hush_hush/_generated" ]
+format.indent-style = "space"
+format.quote-style = "double"
+lint.select = [
+  "B",   # flake8-bugbear
+  "C4",  # flake8-comprehensions
+  "E",   # pycodestyle errors
+  "F",   # pyflakes
+  "I",   # isort
+  "N",   # pep8-naming
+  "SIM", # flake8-simplify
+  "UP",  # pyupgrade
+  "W",   # pycodestyle warnings
+]
+lint.ignore = [
+  "E501", # line too long (handled by the formatter)
+]
+lint.per-file-ignores = { "tests/conftest.py" = [
+  "N815",
+] }  # do_GET/do_POST/... names are BaseHTTPRequestHandler's API, not ours to rename
+# Explicit rather than relying on auto-detection: local and CI runs
+# disagreed on whether `hush_hush` counts as first-party, producing a
+# different import order in each and a lint failure only in one of them.
+lint.isort.known-first-party = [ "hush_hush" ]
+
+[tool.pytest]
+ini_options.testpaths = [ "tests" ]
+ini_options.addopts = "-m 'not contract and not pact and not e2e'"
+ini_options.markers = [
+  "contract: runs against a local Prism mock, needs HUSH_HUSH_BASE_URL",
+  "e2e: runs against a real staging hush-hush, needs HUSH_HUSH_BASE_URL/HUSH_HUSH_API_KEY",
+  "pact: records a Pact consumer contract, needs the pact native library",
+]
+ini_options.asyncio_mode = "auto"

hush_hush-1.2.3/src/hush_hush/__init__.py

@@ -0,0 +1,25 @@
+"""Official Python SDK for hush-hush."""
+
+from ._generated.models.audit_log_entry import AuditLogEntry
+from ._generated.models.audit_log_entry_action import AuditLogEntryAction
+from ._generated.models.health import Health
+from ._generated.models.object_metadata import ObjectMetadata
+from ._generated.models.used_by import UsedBy
+from .client import (
+    API_KEY_ENV_VAR,
+    AsyncClient,
+    Client,
+)
+from .errors import APIError
+
+__all__ = [
+    "API_KEY_ENV_VAR",
+    "APIError",
+    "AsyncClient",
+    "AuditLogEntry",
+    "AuditLogEntryAction",
+    "Client",
+    "Health",
+    "ObjectMetadata",
+    "UsedBy",
+]

hush_hush-1.2.3/src/hush_hush/_generated/__init__.py

@@ -0,0 +1,10 @@
+# Code generated by openapi-python-client from hush-hush/api/openapi.yaml; DO NOT EDIT.
+
+"""A client library for accessing hush-hush"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

hush_hush-1.2.3/src/hush_hush/_generated/api/__init__.py

@@ -0,0 +1,3 @@
+# Code generated by openapi-python-client from hush-hush/api/openapi.yaml; DO NOT EDIT.
+
+"""Contains methods for accessing the API"""

hush_hush-1.2.3/src/hush_hush/_generated/api/audit_log/__init__.py

@@ -0,0 +1,3 @@
+# Code generated by openapi-python-client from hush-hush/api/openapi.yaml; DO NOT EDIT.
+
+"""Contains endpoint functions for accessing the API"""

hush_hush-1.2.3/src/hush_hush/_generated/api/audit_log/query_audit_log.py

@@ -0,0 +1,239 @@
+# Code generated by openapi-python-client from hush-hush/api/openapi.yaml; DO NOT EDIT.
+
+import datetime
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.audit_log_entry import AuditLogEntry
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    object_id: str | Unset = UNSET,
+    caller: str | Unset = UNSET,
+    from_: datetime.datetime | Unset = UNSET,
+    to: datetime.datetime | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["object_id"] = object_id
+
+    params["caller"] = caller
+
+    json_from_: str | Unset = UNSET
+    if not isinstance(from_, Unset):
+        json_from_ = from_.isoformat()
+    params["from"] = json_from_
+
+    json_to: str | Unset = UNSET
+    if not isinstance(to, Unset):
+        json_to = to.isoformat()
+    params["to"] = json_to
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/audit-log",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> list[AuditLogEntry] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = AuditLogEntry.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        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[list[AuditLogEntry]]:
+    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,
+    object_id: str | Unset = UNSET,
+    caller: str | Unset = UNSET,
+    from_: datetime.datetime | Unset = UNSET,
+    to: datetime.datetime | Unset = UNSET,
+) -> Response[list[AuditLogEntry]]:
+    r"""Query the audit log
+
+     Every create, read, update, and delete call is recorded here -
+    this is what answers \"did anyone fetch this ciphertext\" during a
+    rotation or incident, since v1 has no pre-fetch access check.
+    Filters combine with AND when more than one is given.
+
+    Args:
+        object_id (str | Unset):
+        caller (str | Unset):
+        from_ (datetime.datetime | Unset):
+        to (datetime.datetime | Unset):
+
+    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[list[AuditLogEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        object_id=object_id,
+        caller=caller,
+        from_=from_,
+        to=to,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    object_id: str | Unset = UNSET,
+    caller: str | Unset = UNSET,
+    from_: datetime.datetime | Unset = UNSET,
+    to: datetime.datetime | Unset = UNSET,
+) -> list[AuditLogEntry] | None:
+    r"""Query the audit log
+
+     Every create, read, update, and delete call is recorded here -
+    this is what answers \"did anyone fetch this ciphertext\" during a
+    rotation or incident, since v1 has no pre-fetch access check.
+    Filters combine with AND when more than one is given.
+
+    Args:
+        object_id (str | Unset):
+        caller (str | Unset):
+        from_ (datetime.datetime | Unset):
+        to (datetime.datetime | Unset):
+
+    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:
+        list[AuditLogEntry]
+    """
+
+    return sync_detailed(
+        client=client,
+        object_id=object_id,
+        caller=caller,
+        from_=from_,
+        to=to,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    object_id: str | Unset = UNSET,
+    caller: str | Unset = UNSET,
+    from_: datetime.datetime | Unset = UNSET,
+    to: datetime.datetime | Unset = UNSET,
+) -> Response[list[AuditLogEntry]]:
+    r"""Query the audit log
+
+     Every create, read, update, and delete call is recorded here -
+    this is what answers \"did anyone fetch this ciphertext\" during a
+    rotation or incident, since v1 has no pre-fetch access check.
+    Filters combine with AND when more than one is given.
+
+    Args:
+        object_id (str | Unset):
+        caller (str | Unset):
+        from_ (datetime.datetime | Unset):
+        to (datetime.datetime | Unset):
+
+    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[list[AuditLogEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        object_id=object_id,
+        caller=caller,
+        from_=from_,
+        to=to,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    object_id: str | Unset = UNSET,
+    caller: str | Unset = UNSET,
+    from_: datetime.datetime | Unset = UNSET,
+    to: datetime.datetime | Unset = UNSET,
+) -> list[AuditLogEntry] | None:
+    r"""Query the audit log
+
+     Every create, read, update, and delete call is recorded here -
+    this is what answers \"did anyone fetch this ciphertext\" during a
+    rotation or incident, since v1 has no pre-fetch access check.
+    Filters combine with AND when more than one is given.
+
+    Args:
+        object_id (str | Unset):
+        caller (str | Unset):
+        from_ (datetime.datetime | Unset):
+        to (datetime.datetime | Unset):
+
+    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:
+        list[AuditLogEntry]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            object_id=object_id,
+            caller=caller,
+            from_=from_,
+            to=to,
+        )
+    ).parsed

hush_hush-1.2.3/src/hush_hush/_generated/api/health/__init__.py

@@ -0,0 +1,3 @@
+# Code generated by openapi-python-client from hush-hush/api/openapi.yaml; DO NOT EDIT.
+
+"""Contains endpoint functions for accessing the API"""