Python API¶
cpdocs generates the reference of the Python API from the source of every
published version. The whole API is the keyloom package:
| Purpose | API |
|---|---|
| Read configuration in an application | keyloom.load |
| Write configuration with encrypted secrets | keyloom.store, keyloom.secret |
| Encrypt, decrypt or re-encrypt a file | keyloom.encrypt_file, keyloom.decrypt_file, keyloom.reencrypt_file |
| Encrypt or decrypt a single value | keyloom.encrypt_value, keyloom.decrypt_value |
| Name an algorithm | keyloom.Algorithm, keyloom.algorithms |
| Catch failures | keyloom.KeyloomError and its subclasses |
Every parameter is keyword-only and required. algorithm appears only where
something is encrypted, and the caller always names it as a member of
keyloom.Algorithm; decryption takes the algorithm from each envelope.