HCE

Lossless, pronounceable, encrypted codec for any identifier — reversible, format-preserving, human-readable.

Install

pip install hce

Quick Start

import hce

h = hce.Hce(
    key=b"32-byte-secret-key-here-xxxxxx!!",
    level="universal",
    mode="sealed",
)

encoded = h.encode(bytes(range(16)))
decoded = h.decode(encoded)
print(decoded.hex())

API

Constructor

hce.Hce(
    key: bytes | None = None,
    level: str = "universal",
    mode: str = "sealed",
    bit_width: int = 128,
) -> Hce

Core Methods

h.encode(data: bytes) -> str
h.decode(input: str) -> bytes
h.recover(input: str) -> bytes

Domain Configuration

h.with_bit_width(bits: int) -> Hce
h.with_modulus(modulus: int) -> Hce
h.with_cipher(kind: str, key: bytes | None = None) -> Hce

Output Configuration

h.with_case("upper" | "lower") -> Hce
h.with_check_syllables(n: int) -> Hce
h.with_separator(sep: str) -> Hce

Chunking

h.with_chunk_none() -> Hce
h.with_chunk_fixed(char_size: int) -> Hce
h.with_chunk_pattern(pattern: list[int]) -> Hce

Timestamp

h.with_timestamp_config(epoch_ms: int, granularity: str) -> Hce

Levels

Each level uses a different phoneme set:

Modes

Development

cd crates/hce-py
python -m venv .venv
source .venv/bin/activate
pip install maturin pytest
maturin develop
pytest tests/

License

MIT