API Reference¶

callooktools allows for both synchronous and asynchronous usage via two main classes, callooktools.CallookSync and callooktools.CallookAsync. These inherit from callooktools.CallookAbc. See there for some properties.

class callooktools.CallookAbc¶: The base class for CallookSync and CallookAsync. This should not be used directly.

Synchronous¶

class callooktools.CallookSync(session=<requests.sessions.Session object>)¶

The synchronous callook API object

Parameters: session (requests.Session) – A requests session to use for requests

property session¶

Getter: gets the requests session
Return type: requests.Session
Setter: sets the requests session
Type: requests.Session

get_callsign(callsign)¶

Gets QRZ data for a callsign.

Parameters: callsign (str) – the callsign to search for
Returns: the QRZ data for the callsign
Return type: CallookCallsignData

Asynchronous¶

class callooktools.CallookAsync(session=None)¶

The asynchronous callook API object

Parameters: session (Optional[aiohttp.ClientSession]) – An aiohttp session to use for requests

property session¶

Getter: gets the aiohttp session
Return type: aiohttp.ClientSession
Setter: sets the aiohttp session
Type: aiohttp.ClientSession

async start_session()¶: Creates a new aiohttp.ClientSession object for the CallookAsync object

async close_session()¶: Closes a aiohttp.ClientSession session for the CallookAsync object

async get_callsign(callsign)¶

Gets QRZ data for a callsign.

Parameters: callsign (str) – the callsign to search for
Returns: the QRZ data for the callsign
Return type: CallookCallsignData