Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 4.28 KB

README.md

File metadata and controls

107 lines (72 loc) · 4.28 KB
Raw

PyCape

The Cape SDK for Python is a library that provides a simple way to interact with the Cape Privacy API.

Table of Contents
  1. Installation
  2. Usage
  3. Contributing

Installation

Prerequisites

  • Python 3.7+
  • pip
  • Make (if installing from source)

We recommend that you use a Python "Virtual Environment" when installing pycape.

Install via pip

You can install the current release with:

pip install pycape

Install from source

To install the library from source and all of its dependencies, run:

git clone https://github.com/capeprivacy/pycape.git
cd pycape
make install-release

Usage

To run a function, you need to first deploy a function and generate a personal access token. You can deploy a function with the Cape CLI by running cape deploy. cape deploy will return a function ID and a checksum. Non-CLI users can still consume the deployed function from the SDK as long as they have a copy of the deployer's personal access token. You can checkout the examples repository to see the process end to end.

run

Run is used to invoke a function once with a single input. A connection to a Cape function is created, then terminated upon completion (no set up or tear down is required). If you wish to invoke the same function multiple times without terminating the connection between calls, please see invoke. By default, inputs and outputs are expected to be bytes.

Note: You can optionally use Serdio to help with serialization and deserialization of inputs and outputs. To learn more, please check out this example.

Example run_echo.py:

from pycape import Cape

cape = Cape(url="https://app.capeprivacy.com")
token: str = "eyJhbGci..." # full token omitted for brevity

f = cape.function("pycape-dev/echo")
t = cape.token(token)
result = client.run(f, t, b"Hello!")
print(result.decode())
# Hello!

invoke

Invoke is used to run a function repeatedly with multiple inputs. The connection to your Cape function is not terminated between invocations. It gives you more control over the lifecycle, and can be more efficient. Prior to calling invoke, connect to your function and then close it when you are finished. You can also call invoke inside of a Cape.function_context, which will handle connecting and closing the connection for you. See the docs for a usage example.

Example invoke_echo.py:

from pycape import Cape

cape = Cape(url="https://app.capeprivacy.com")
token: str = "eyJhbGci..." # full token omitted for brevity

f = cape.function("pycape-dev/echo")
t = cape.token(token)

cape.connect(f, t)
result = cape.invoke(b"Hello Alice!")
print(result.decode())
# Hello Alice!
result = cape.invoke(b"Hello Bob!")
print(result.decode())
# Hello Bob!
result = cape.invoke(b"Hello Carole!")
print(result.decode())
# Hello Carole!

cape.close()

Please note that there is a 60-second inactivity timeout on the enclave connection. You may need to monitor the connection status and reconnect if there is a significant wait between inputs.

(back to top)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Read more about how to contribute to the Cape SDK in CONTRIBUTING.

(back to top)