Attendance Nudger

This application was developed in partnership with Mind The Gap, Boston, 501(c)3.

Building The Application

Download source code

git clone https://github.com/JamesVorder/email_nudges.git
cd ./email_nudges

Set up a virtual environment

Note: I use pyenv to specify python 3.7.8 for reliable builds. There seem to be problems with later versions of python.

python -m venv ./.py3env
. ./.py3env/bin/activate

Install dependencies

pip install -r requirements.txt

Build with Briefcase

This cross-platform app was generated by Briefcase - part of The BeeWare Project

Depending on the desired output, run one of the following commands from your python3 virtual environment:

• python setup.py linux -s
• python setup.py macos -s
• python setup.py windows -s

The builds will be placed in a folder corresponding to the output you chose.

Deploying The Application

It's a desktop app, so distribute the app itself however you would like. Ther is some required cloud infrastructure, though.

Google Cloud Setup

You will need a GCP project, a GMail API instance, and some valid credentials. Follow the guides:

• Python Quickstart
• Send Emails
• Create Credentials

Once you have these things set up, the credentials.json file goes in the config module.