nectarpy 0.11.0

A Python API module designed to run queries on Nectar

PYTHON NECTAR MODULE

This is a Python API module designed to run queries on Nectar, add bucket information, and set policies.

Install

pip3 install nectarpy

Python Example

from nectarpy import Nectar

API_SECRET = "<api-secret>"

nectar = Nectar(API_SECRET)

policy_id = nectar.add_policy(
    allowed_categories=["*"],
    allowed_addresses=[],
    allowed_columns=["*"],
    valid_days=1000,
    price=123,
)

TEE_DATA_URL = "https://<ip-address>:5229/"

bucket_id = nectar.add_bucket(
    policy_ids=[policy_id],
    data_format="std1",
    node_address=TEE_DATA_URL,
)

result = nectar.train_model(
    type="linear-regression",
    parameters='{"xcols":["heart_rate","age"],"ycol":"height"}',
    filters='[ { "column": "smoking", "filter": "=", "value": false } ]',
    use_allowlists=[False],
    access_indexes=[0],
    bucket_ids=[bucket_id],
    policy_indexes=[0],
)

print(result)

Integration Tests

Step 1: Create a .env file

API_SECRET=0x123...
NETWORK_MODE=<localhost | moonbase | moonbeam>
TEE_DATA_URL=https://<ip-address>:5229/

Step 2: Run!

python3 tests.py