ClerkBot

These are a set of utilities potentially helpful for clerks in The Church of Jesus Christ of Latter-day Saints.

The scripts generally need your LDS Account credentials. You can either set these environment variables, or the scripts will prompt interactively:

LDS_USERNAME
LDS_PASSWORD

Actions

Actions are invoked from the command line. Try:

clerkbot -h

Some actions have further explanation, below.

Missionary Accounts

This action creates emails for missionary accounts to let families of missionaries know what the current balance is. The emails are created as drafts in a Gmail account. If the email looks good, you can send it from your drafts folder.

There are a couple of setup steps needed for this action:

You'll need to follow the "Turn on the Gmail API" instructions at https://developers.google.com/gmail/api/quickstart/python and save client_secret.json in a conf directory at the root of the project.
Create conf/config.ini to map missionary accounts to email addresses. This should look something like this:

[DEFAULT]
clerk_name: John Clerk
clerk_email: john.clerk@example.org

[emails]
Doe, Jane: doefamily@live.com
Smith, John: jonsdad@gmail.com, jonsmom@gmail.com

Record Notifications

This action sends an email notification of any member records that have been moved in or out of the ward since the last time the action was run. You might configure a cron job to run this daily.

The notification email is sent to email addresses (comma separated) in the [emails] section of the config.ini specified by the record_notifications key.

Interview Notifications

This action sends an email with the Action and Interview List attached. This is useful for a ward that has an assistant executive secretary that might not have access to the list via LCR.

The email is sent to addresses in the [emails] section of the config.ini specified by the interview_notifications key.

Docker

To build an image tagged "clerkbot-img", in the project root run:

docker build -t clerkbot-img .

To run clerkbot in a new container:

docker run -t --rm -v ~/clerkbot/conf:/conf -v ~/clerkbot/output:/output \
    -e TZ=America/Denver \
    -e "LDS_USERNAME=myusername" -e "LDS_PASSWORD=mypassword" \
    --name clerkbot-cont clerkbot-img clerkbot --records

Note that some tasks depend on the correct time zone being set, so set the TZ value accordingly.

To use a pre-built container, look for genericmoniker/clerkbot on DockerHub.

Project Notes

Written for Python 3.
Requirements are managed with pip-tools.

genericmoniker / ClerkBot