Skip to main content

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.

Metadata

Release files for tm_parser 0.24.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tm_parser 0.24.2
File Size Uploaded
tm_parser-0.24.2.tar.gz 26.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tm_parser 0.24.2
File Interpreter ABI Platform
tm_parser-0.24.2-py3-none-any.whl Python 3 none any Details

Total release size: 57.4 kB

Release files / tm_parser-0.24.2.tar.gz

Download URL tm_parser-0.24.2.tar.gz
Size 26.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c3be6d91a859700a2c873511a6533db1f338e14b171d1ed1a07c82e11f4a3a53
BLAKE2b-256 checksum
How to use checksums
20f782f81e173ec0bfa92ee7f93edba9ce2a408c518b813839f41127a48afc7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"EndeavourOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / tm_parser-0.24.2-py3-none-any.whl

Download URL tm_parser-0.24.2-py3-none-any.whl
Size 31.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
df067a95c696f4f39fac609d70ee415fa6c64965c70159afb055cc5790785406
BLAKE2b-256 checksum
How to use checksums
516195aa89d72923f189f9f2ce3277947fc9928bb23901e63d741f438faa275e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"EndeavourOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.24.2 This release

2 release files

0.24.1

2 release files

0.24.0

2 release files

0.23.3

2 release files

0.23.2

2 release files

0.23.1

2 release files

0.23.0

2 release files

0.22.0

2 release files

0.20.0

2 release files

0.19.0

2 release files

0.18.0

2 release files

0.17.9

2 release files

0.17.8

2 release files

0.17.7

2 release files

0.17.6

2 release files

0.17.5

2 release files

0.17.4

2 release files

0.17.3

2 release files

0.17.2

2 release files

0.17.1

2 release files

0.17.0

2 release files

0.16.7

2 release files

0.16.6

2 release files

0.16.5

2 release files

0.16.4

2 release files

0.16.2

2 release files

0.16.1

2 release files

0.16.0

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.14.1

2 release files

0.14.0

2 release files

0.13.0

2 release files

0.12.2

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.11.1

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9.1

2 release files

0.9.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page