PyADIF-File

Author: Andreas Schawo, DF1ASC (HamQTH, eQSL)

Convert ADIF ADI content (ham radio QSO logs) to dictionary and vice versa

The required/resulting dictionary format for ADI is

{
    'HEADER': 
        {'ADIF_HEADER_FIELD_NAME': 'Value',
         'USERDEFS': [list of user definitions]},
    'RECORDS': [list of records]
}

For ADI the header or each record is/must be a dictionary in the format

{
    'ADIF_FIELD_NAME': 'Value',
}

The value can be a str, int, float or bool. Booleans are translated to Y or N.

For ADI a user definition is a dictionary of

{
    'dtype': one char representing the type,
    'userdef': the field definition text
}

The library also supports ADX import/export as compatible as possible to the ADI part. Though it will differ in handling application and user definitions. It relys on the ADX schemas from adif.org. For the ADX import there is no validation by default to be able to read fast.

For more details visit the API documentation

Examples

See example.py for a complete example. Running example.py should produce example.adi and example.adx.

Installation

The package is available via PyPI

pip install pyadif-file

Usage

For reading and writing files you can use adi.load or adi.dump. There is a corresponding variant for handling string: adi.loads and adi.dumps.

Here is an example for reading an ADI file:

from adif_file import adi

adi_doc = adi.load('qsos.adi')
for rec in adi_doc['RECORDS']:
    if "CALL" in rec:
        print(f'QSO on {rec["QSO_DATE"]} at {rec["TIME_ON"]} with {rec["CALL"]}')

====
QSO on 20231008 at 1145 with DL4BDF
QSO on 20231008 at 1146 with DL5HJK
QSO on 20231009 at 1147 with M3KJH
QSO on 20231010 at 1148 with HB4FDS

Exporting ADI

If an empty header is provided, the fields are generated with suiting defaults. Missing header fields are inserted.

Empty record fields and empty records are not exported at all.

*_INTL fields are not exported (see ADIF specification). Non ASCII characters are substituted on export by default with an underscore _. A warning will be raised. Deactivating this will rais an exception for each field containing non ASCII chars.

To substitute non ASCII chars you may want to provide a different substitution char e.g. # or a substitution map e.g. for german lang {'ä': 'ae', 'ß': 'ss'}.

Source Code

The source code is available at Codeberg

Copyright

PyADIF-File © 2023 by Andreas Schawo is licensed under CC BY-SA 4.0

PyADIF-File uses

• xmlschema Copyright (c), 2016-2022, SISSA (Scuola Internazionale Superiore di Studi Avanzati)
• xmltodict Copyright (c), 2012 Martin Blech and individual contributors