Evervault SDK
Project description
Evervault-Python
Getting Started
Python SDK for Evervault
Prerequisites
To get started with the Evervault Python SDK, you will need to have created a team on the evervault dashboard.
We are currently in invite-only early access. You can apply for early access here.
Installation
pip install evervault
Setup
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!' })
API Reference
evervault.encrypt
Encrypt lets you encrypt data for use in any of your evervault cages. You can use it to store encrypted data to be used in a cage at another time.
evervault.encrypt(data = dict | str)
Parameter | Type | Description |
---|---|---|
data | dict or str |
Data to be encrypted |
evervault.run
Run lets you invoke your evervault Cages 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
Encrypt your data and use 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. |
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
evervault-0.1.1.tar.gz
(8.2 kB
view hashes)
Built Distribution
evervault-0.1.1-py3-none-any.whl
(10.7 kB
view hashes)
Close
Hashes for evervault-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65bf05ed0eb6c7dde1859146a99688416af19c65957f6c0fb8dec1f3109c2782 |
|
MD5 | 26827f2b9916a53c82c6f90f9ee34ff3 |
|
BLAKE2b-256 | d8d24f64b56a6a02ec49f42d390b37498a0a70665bb75f22e25c7b8fb5d11c31 |