toc

Python SDK

A full reference of our Python SDK.

You can use our Python SDK to:

  1. Encrypt data at your server
  2. Run your Cages
  3. Encrypt/decrypt data with Relay

You can use our Python SDK to encrypt data — rather than with Relay — and still send it to a third-party via Outbound Interception. Encrypting with our backend SDKs is best for developers who want to avoid the network latency of Relay and/or want to avoid sending plaintext data to Relay to be encrypted.

Encrypting data with our backend SDKs instead of Relay may expose you to greater compliance burden because plaintext data touches your server before it is encrypted.

You don’t need to change your database configuration. You can store Evervault-encrypted data in your database as you would the plaintext version.

Installation

Our Python SDK is distributed via pypi, and can be installed using pip.

bash
pip install evervault

Initialization

python
import evervault
# Initialize the client with your team’s API key
evervault.init("<YOUR_API_KEY>")
# Encrypt your data
encrypted = evervault.encrypt({ "name": "Claude" })
# Process the encrypted data in a Cage
result = evervault.run("<YOUR_CAGE_NAME>", encrypted)

Reference

The Evervault Python SDK exposes three functions:

  • evervault.init()
  • evervault.encrypt()
  • evervault.run()

evervault.init()

evervault.init() initializes the SDK with your API key. Configurations for the interception of outbound requests may also be passed in this function.

python
evervault.init(api_key = str[, decryption_domains = list, retry = bool, curve = str])
ParameterTypeDescription
api_keystrThe API key of your Evervault Team
decryption_domainslist(str)Requests sent to any of the domains listed will be proxied with Outbound Interception. Wildcard domains are supported. See Outbound Relay to learn more.
retryboolRetry failed Cage operations (maximum of 3 retries; False by default)
curvestrThe elliptic curve used for cryptographic operations. See Elliptic Curve Support to learn more.
debugRequestsboolOutput request domains and whether they were sent through outbound interception

We provide two curve options. You can set them as follows:

  • curve = evervault.Curves.SECP256K1 or
  • curve = evervault.Curves.SECP256R1

evervault.encrypt()

evervault.encrypt() encrypts data for use in your Cages. To encrypt data at the server, simply pass a dict or string into the evervault.encrypt() function. Store the encrypted data in your database as normal.

python
evervault.encrypt(data = dict | string)
ParameterTypeDescription
datadict or stringData to be encrypted.

evervault.run()

evervault.run() lets you invoke a Cage with a given payload.

python
evervault.run(cage_name = str, data = dict[, options = dict])
ParameterTypeDescription
cage_namestringName of the Cage to be run.
datadictPayload for the Cage.
optionsdictOptions for the cage run.
OptionsTypeDefaultDescription
asyncBooleanFalseRun your Cage in async mode. Async Cage runs will be queued for processing.
versionIntegerNoneSpecify the version of your Cage to run. By default, the latest version will be run.

Was this page useful?