Python API

odorik

OdorikException

exception odorik.OdorikException

Base class for all exceptions.

Odorik

Odorik(user='', password='', url=None, config=None):
Parameters:
  • user (string) – User ID
  • password (string) – API password
  • url (string) – API server URL, if not specified default is used
  • config (OdorikConfig) – Configuration object, overrides any other parameters.

Access class to the API, define user, password and optionally API URL.

odorik.get(path, args=None)
Parameters:
  • path (string) – Request path
  • args (dict) – Optional request parameters
Return type:

string

Performs single API GET call.

odorik.get_json(path, args=None)
Parameters:
  • path (string) – Request path
  • args (dict) – Optional request parameters
Return type:

object

Performs single API GET call and parses JSON reply including error handling.

odorik.balance()
Return type:float

Returns current balance.

odorik.mobile_data(from_date, to_date, number=None)
Parameters:
  • from_date (datetime.datetime) – Starting date
  • to_date (datetime.datetime) – Ending date
  • number (string) – Phone number in form of 00420789123456
Return type:

list

Returns mobile data usage list in given interval. Optionally filtered for given number.

odorik.send_sms(recipient, message, sender='5517')
Parameters:
  • recipient (string) – Number where to sent SMS.
  • message (string) – Text of the message.
  • sender (string) – Optional sender number.
Return type:

string

Sends a SMS message.

odorik.callback(caller, recipient, line=None)
Parameters:
  • caller (string) – Number which is calling.
  • recipient (string) – Number to call.
  • line (string or None) – Line to use for accounting.
Return type:

string

Initiates callback.

calls(from_date, to_date, line=None, status=None, direction=None):
Parameters:
  • from_date (datetime.datetime) – Starting date
  • to_date (datetime.datetime) – Ending date
  • line (string or None) – Line to use for listing
  • status (string) – Call status, one of ‘answered’, ‘missed’
  • direction (string) – Call direction, one of ‘in’, ‘out’, ‘redirected’
Return type:

list

Returns list of calls in given interval. Optionally filtered for given line.

sms(from_date, to_date, line=None):
Parameters:
  • from_date (datetime.datetime) – Starting date
  • to_date (datetime.datetime) – Ending date
  • line (string or None) – Line to use for listing
Return type:

list

Returns list of sms in given interval. Optionally filtered for given line.

odorik.lines()
Return type:list

Returns list of dictionaries with information about lines.

odorik.config

OdorikConfig

class odorik.config.OdorikConfig(section='odorik')
Parameters:section (string) – Configuration section to use

Configuration file parser following XDG specification.

load(path=None)
Parameters:path (string) – Path where to load configuration.

Loads configuration from a file, if none is specified it loads from odorik configuration file placed in XDG configuration path (~/.config/odorik and /etc/xdg/odorik).

odorik.main

odorik.main.main(settings=None, stdout=None, args=None)
Parameters:
  • settings (list of tuples) – settings to override
  • stdout (file) – stdout for printing output, uses sys.stdout as default
  • args (list) – command line argumets to process, uses sys.args as default

Main entry point for command line interface.

@odorik.main.register_command(command)

Decorator to register Command class in main parser used by main().

Command

class odorik.main.Command(args, config, stdout=None)

Main class for invoking commands.