protopia 0.2.5

Python agent for protopia

Python Protopia Agent

This is a Python implementation of the Protopia Agent.

Install via Pypi

pip install protopia

Usage via Pypi

import protopia

client = protopia.Agent()
client.get_option()
# returns will be
# > PROTOPIA_CLOUD_URL is set to api.stage-01.stage.protopia.ai:443
# > TOKEN_URL is set to https://protopia-cloud-stage-01.auth.us-east-1.amazoncognito.com/oauth2/token
# > SCOPES is set to ['https://api.stage-01.protopia.ai/noise:read']
# > OIDC_CLIENT_ID is set to None
# > OIDC_CLIENT_SECRET is set to None

client.set_client(client_id, client_secret)
# returns will be (See below to retrieve client_id and client_secret)
# > OIDC_CLIENT_ID is set to client_id
# > OIDC_CLIENT_SECRET is set to client_secret

client.connect()
# returns will be
# > successfully connected to staging cloud API

dist = client.get_noise_distribution(nnid)
# returns will be encrypted noise distribution

Development

Prerequisites

Install the following programs:

• Python version 3.8+
• Run pip3 install -r requirements.txt
• protoc
  • In MacOS this can be installed by running brew install protoc

Preconfiguration

The following environment variables must be exported prior to running the agent:

• OIDC_CLIENT_ID the client ID of the agent issued by Cognito.
• OIDC_CLIENT_SECRET the client secret of the agent issued by Cognito.

You will get the predefined agent in AWS cognito console New user creation is described in the cloud/example/nose_store/upload

Installation for local package

Once above is set then you can install the package by following command

pip install .

Build the package

You can execute the following line to build the package

python setup.py bdist_wheel

Upload the package to Pypi

You'll need twine to upload the package

pip install twine

Then you'll need ID and Password for Pypi. contact [e-mail] to get it.

twine upload dist/{build location from above}
# ex twine upload dist/protopia-0.1.0-py3-none-any.whl

Generting Python From ProtocolBuffer

A script is provided to generate Python code from the ProtocolBuffer defintion of the gRPC protocol exposed by Protopia Cloud. To re-generate Python code from the ProtocolBuffer definition, run:

make protoc

This will be executed in the cloud repo

Then copy cloud/protos/protopia-api/api in cloud repo and paste to py-agent/protopia/api