HKEY Docs
← Back to SDKs & downloads

SDK Documentation

Python SDK

Readable, testable reference implementation of the Hotkey Encryption System (HKEY v1) for Python. Ideal for scripts, automation, backends, and cross-language vector testing.

Requirements

Package contents

Install (local)

pip install -e ./sdk/python
# or run directly with PYTHONPATH pointing to sdk/python

Quick start

from hkey import HotkeyEncryption

hkey = HotkeyEncryption(
    gesture_salt="lab.freezer.alpha",
    chords=["Ctrl+Alt+H", "Shift+K", "Meta+E", "Y"],
)

packet_json = hkey.encrypt_text("sensitive payload")
plain = hkey.decrypt_text(packet_json)

print(hkey.digest)  # sequence digest
print(plain)        # "sensitive payload"

Run the example

PYTHONPATH=sdk/python python3 sdk/python/example.py

API overview

HKEY v1 behavior

Good practices

Educational reference design. For sensitive or regulated production data, obtain security review and consider audited standard AEAD deployments.