diff --git a/README.md b/README.md index 3b57ea7..835a804 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,24 @@ As of v0.0.1: * The eQSL module has most of the functionality of eQSL's API, but is incredibly unpolished and needs more work. * The QRZ module exists; the Logbook API is currently only supported for FETCH operations, and the XML Interface is not supported yet. * The ClubLog module is on-hold pending the ready-status of the other modules. + +## How do I use it? + +An example of pulling a Logbook from LOTW: + +```py +from qspylib import lotw +LOTWAccount = lotw.LOTWSession("callsign", "password") +logbook = LOTWAccount.fetch_logbook() +``` +This will give you a `Logbook` object, which contains a list of QSO objects and a parsed, usable adif_io log. The adif_io log property contains all the ADIF info that LOTW outputs (and likewise for other logging sites); the built-in log property of a `Logbook` object contains only some limited information, like callsign, band, mode, date, time, and QSL status from the originating site (which is a little handy as a single-reference for if a QSO is a QSL, since different sites use different, extra ADIF fields to express being QSL'd on their platform.) + +Other functions of APIs are generally available, like checking if an eQSL is verified: + +```py +from qspylib import eqsl +confirmed, raw_result = eqsl.verify_eqsl('N5UP', 'TEST', '160m', 'SSB', '01/01/2000') +``` +This will return a tuple; here, `confirmed` will be False, since this QSO is not verified on eQSL, and `raw_result` will contain any extra information eQSL provides, for instance, if it's Authenticity Guaranteed. + +The best way to find out the functions, methods and objects available is to code dive; an okay-amount-of-effort has been put in to documenting the code with doc strings.