Evervault SDK
Project description
Evervault Python SDK
The Evervault Python SDK is a toolkit for encrypting data as it enters your server, and working with Cages.
Getting Started
Before starting with the Evervault Python SDK, you will need to create an account and a team.
For full installation support, book time here.
Documentation
See the Evervault Python SDK documentation.
Installation
Our Python SDK is distributed via pypi, and can be installed using pip
.
pip install evervault
Setup
To make Evervault available for use in your app:
import evervault
# Initialize the client with your team's api key
evervault.api_key = <YOUR-API-KEY>
# Encrypt your data and run a cage
result = evervault.encrypt_and_run(<CAGE-NAME>, { 'hello': 'World!' })
Reference
The Evervault Python SDK exposes four functions.
evervault.encrypt()
evervault.encrypt()
encrypts data for use in your Cages. To encrypt data at the server, simply pass a python primitive type into the evervault.encrypt()
function. Store the encrypted data in your database as normal.
evervault.encrypt(data = dict | list | set | str | int | bool)
Parameter | Type | Description |
---|---|---|
data | dict , list , set , str , int , bool |
Data to be encrypted |
evervault.run()
evervault.run()
invokes a Cage with a given payload.
evervault.run(cageName = str, payload = dict[, options = dict])
Parameter | Type | Description |
---|---|---|
cageName | str |
Name of the Cage to be run |
data | dict |
Payload for the Cage |
options | dict |
Options for the Cage run. |
Cage Run Options
Option | Type | Default | Description |
---|---|---|---|
async | Boolean |
False |
Run your Cage in async mode. Async Cage runs will be queued for processing. |
version | Integer |
None |
Specify the version of your Cage to run. By default, the latest version will be run. |
evervault.encryptAndRun()
evervault.encryptAndRun()
encrypts data and uses it as the payload to invoke the Cage.
evervault.encrypt_and_run(cageName = str, data = dict[, options = dict])
Parameter | Type | Description |
---|---|---|
cageName | str |
Name of the Cage to be run |
data | dict |
Data to be encrypted |
options | dict |
Options for the Cage run. |
evervault.cages()
Return a dict
of your team's Cage objects in dict
format, with cage-name
as keys.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/evervault/evervault-python.
Feedback
Questions or feedback? Let us know.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for evervault-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e9e2c93046b413cf7359377b757050b7888c051a404fa206ba5461f11042955 |
|
MD5 | ea6e9758188204e99ce8428034506ee3 |
|
BLAKE2b-256 | a1ed1a02258aaeb1acf3d4966187c1191fd9746c503a22c9dceeccfa6764e0e0 |