From pip install to a proof in five steps.

Install from PyPI. There are no wheels to compile and no transitive dependencies to resolve — it is pure Python.

pip install commit-reveal

Construct a scheme and commit. You get back a commitment (safe to publish) and a salt (keep it secret until reveal).

from commit_reveal import CommitRevealScheme

scheme = CommitRevealScheme()               # sha256 by default
commitment, salt = scheme.commit("my bid: 42")

Later, reveal the value with its salt. The check is timing-safe (hmac.compare_digest). A wrong value returns False.

assert scheme.reveal("my bid: 42", salt, commitment)   # True
assert not scheme.reveal("my bid: 43", salt, commitment)  # False

Opt in to the Schnorr ZKP path. You can prove you know the committed value without publishing it — useful for hidden-then-verified votes.

scheme = CommitRevealScheme(use_zkp=True)
commitment, salt = scheme.commit("secret")

public_key, R_compressed, challenge, response = scheme.create_zkp_proof(
    "secret", salt, commitment
)
assert scheme.verify_zkp_proof(
    commitment, public_key, R_compressed, challenge, response
)

For interactive use, the secure CLI prompts via getpass, never echoes the value, and never writes plaintext to disk (files are mode 0600).

commit-reveal-secure commit my-bid
commit-reveal-secure reveal my-bid
commit-reveal-secure list