tm_parser 0.17.6

Parse Troopmaster export files into TOML, YAML, or JSON

tm_parser

(c) Michael Perkins, 2023, 2024

Introduction/usage

Parses an advancement/individual history PDF from troopmaster, into YAML/TOML/JSON format or for use in Python projects. Also hooks into the objexplore browser for data checking/viewing.

Installation

pip install tm-parser

Instructions:

In troopmaster, under reports -> advancement -> individual history

• select all the scouts you want to report
• select all the ranks you want to report
• Do not select "Omit details on completed ranks"
• Other than that, any other options can be included or excluded (I only tested a few configurations. if it doesn't work, select everything)

generate the report and save it to a PDF. -- we will use "export.pdf" as the output file name

by default, the output is to the console in YAML format

Then run:

tmparse -o output.yaml export.pdf

Options:

-t --output-type  [yaml], json or toml

-o --outfile output filename

This produces output of the desired type.

-e --explore opens an objexplore window for your scouts so you can explore the data

YAML can be read in python with:

import yaml

with open('output.yaml') as f:

    scouts = yaml.safe_load(f)

Using tm_parser in code:

from tm_parser import Parser

#initializing the parser automatically parses the file and stores
#the information in TmParser().scouts
parser = TmParser(infile='filename.pdf')


# Iterating on the parser yields scouts
for scout in parser:
    print('----------------------------------------------')
    print(f"{scout['Data']['Name']:26}Date       Eagle Req")
    print('----------------------------------------------')
    ## do something with scout
    if "Merit Badges" in scout:

        #sort merit badges by date ascending
        for badge, data in sorted(scout['Merit Badges'].items(), 
                                    key=lambda x: x[1]['date']):
            print(f"{badge:26}{data['date']} {data['eagle_required']}")

Yields:

----------------------------------------------
Smith, John               Date       Eagle Req
----------------------------------------------
Climbing                  2017-03-11 False
Mammal Study              2017-06-29 False
Leatherwork               2017-06-30 False
Swimming                  2017-06-30 True
Kayaking                  2018-06-29 False
Wilderness Survival       2018-06-29 False
Rifle Shooting            2018-06-29 False
First Aid                 2018-09-29 True

By default the information is a dictionary, with the scout names as keys, and each scout is a dictionary with the following keys:

• Activity Totals
• Data - contains biographical data
• Leadership
• Merit Badges
• Order of the Arrow
• Partial Merit Badges
• Rank Advancement
• Training Courses

All dates have been parsed into datetime.date objects, in YYYY-MM-DD format, and are null if not assigned in the incoming data.