incountry 0.3.0

InCountry Storage SDK

Introduction

This is the python SDK for the InCountry storage network. Sign up for a free account at https://incountry.com, then copy your Environment ID (the UUID) and the API key.

Installation

Use pip or pipenv to install the package:

pip3 install incountry

and now use the SDK:

python

> import incountry

> incdb = incountry.Storage(env_id="4e00667a-58a4-420b-97b7-243073124b89", \
              api_key="key.yowivz.8ec54a9e647d43cbbc66-8b3096e7a70f", secret_key="any secret value")

> incdb.write(country='ru', key='key1', body="Store this data in Russia")

> r = incdb.read(country='ru', key='key1')
> print(r)
{'body': 'Store this data in Russia', 'key': 'key1', 'key2': None, 'key3': None, 'profile_key': None, 'range_key': None, 'version': 1}

> incdb.delete(country='jp', key='key1')
> r = incdb.read(country='jp', key='key1')
> print(r)
None

Instead of passing parameters, you can configure the client in your environment:

export INC_ENV_ID=<environment id>
export INC_API_KEY=<api key>
export INC_SECRET_KEY=`uuidgen`

API

incountry.Storage(params)

Returns a storage API client.

@param env_id: The id of the environment into which you wll store data
@param api_key: Your API key
@param endpoint: Optional. Will use DNS routing by default.
@param encrypt: Pass False to **disable** encryption of values. This is not recommended.
@param secret_key: pass the encryption key for AES encrypting fields
@param debug: pass True to enable some debug logging
@param use_ssl: Pass False to talk to an unencrypted endpoint

Storage.write(params)

Writes a single record to the storage network.

@param country: required - 2 letter country code indicating location to store data
@param key: required - unique key for this record (unique within the environment and country)
@param body: body of the record in any format
@param profile_key: identifier of the end-customer which owns this data
@param range_key: sorted key for the record, like a timestamp. BigInt type.
@param key2: secondary key to lookup the record
@param key3: secondary key to lookup the record

Storage.read(params)

Reads a single record from the storage network.

@param country: required - 2 letter country code indicating location where the data is stored
@param key: required - primary key for this record 

Storage.delete(params)

Delete a single record from the storage network.

@param country: required - 2 letter country code indicating location where the data is stored
@param key: required - primary key for this record