avni.api.client module#

client for accessing avni api

class avni.api.client.Client(api_key='', timeout=300, api_init_file=None)[source]#

Bases: object

checkConnection()[source]#: checks if the avni api is accessible

call(path, parameters=None, time_out=None)[source]#: general form for api calls, returns json as python dictionary

checkUserStats()[source]#: checks stats for a user

searchForApiKey(api_init_file=None)[source]#

searches for API Key Input: ——

api_init_file: the api.ini file full path. If None, will default to
looking in avni/config/api.ini

api_key: the api key. Empty string if not found

setApiConfig(api_key='', api_init_file=None)[source]#

builds the api.ini file Input: ——

api_key: the api key to store. Will pull from self.key if not
specified.

api_init_file: the file to store key (subsequents calls to api will
need to specify the directory if not using the default). Default is avni/config/api.ini

no output