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 Relay. 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

The Evervault Python SDK will automatically route all outbound HTTPS requests through Relay for decryption by overriding your default HTTP Agent in the requests library. To disable this behaviour, set intercept to false in the initialization options.

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('hello-cage', 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[, intercept = bool, ignore_domains = list])
ParameterTypeDescription
api_keystrThe API key of your Evervault Team
interceptboolRoute outbound requests through Evervault to automatically decrypt encrypted fields.
ignore_domainslist(str)Requests sent to any of the domains in this list will not be intercepted

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?