hush-hush-python

The official Python SDK for hush-hush, generated from its OpenAPI spec and kept in sync with it automatically.

Install

pip install hush-hush

Requires Python 3.11 or newer.

Quickstart

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. Entries come oldest first; pass order="desc" for
# newest first.
for entry in client.query_audit_log(order="desc"):
    print(entry.action, entry.object_id, entry.timestamp)

AsyncClient offers the same methods (await client.get_object(...)) 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 for everything else. The latest green run's test and coverage reports are at https://apis.ryankes.eu/hush-hush-python/reports/.

Versioning

This SDK's version tracks hush-hush's OpenAPI spec, not this repo's own commit history — see CONTRIBUTING.md for how a spec change becomes a release.

License

MIT