This repo contains various scripts used to arrange phone buddies and manage the organization.
Hi! This project is under active development. We are currently working on fixing bugs and refactoring to allow for future development.
Our long-term goal (within the next 6 months to a year) is to have a system that can be administered by a group of Afghan volunteers instead of Seth and Teo.
- Fixing bugs (see project issues for specifics)
- Adding integration and unit tests
- Moving to a more robust deployment than an EC2 box with Cron (not pretty, but it's worked for over 6 months with zero issues)
This script emails phone buddy pairs information about each other to allow them to connect.
Every 24 hours at midnight or 1 am California/Pacific Time (depending on daylight savings), the following script runs:
python email_phone_buddies.py --send-emails --robot
Coming soon: we'd like to run the script every 30 minutes instead of every 24 hours in order for it to report whether there would be any issues (like data being incorrectly filled out, etc.)
It does the following:
- Coming soon: validates the database and that the list of buddies looks good. If there are any issues, report those to the admins if it's been more than 30 minutes since the issue occurred.
- Checks whether there's a date in the Process sheet that meets the following criteria:
- Has a date that's in the past (assumes it's sorted)
- Has all the prerequisite rows filled out with
yoryes(case insensitive)
- Checks whether it should send to the admin group or real email list depending on whether the beta column has a
yoryes(case insensitive) - Sends the phone buddy list to the appropriate list (admins or phone buddies)
- Saves the output
- Fills in the corresponding cell in the Process sheet with an update on the outcome (Yes or Error). This means that Seth (or anyone else) can easily see if something went wrong with the script that Teo needs to check on or if the script didn't run at all.
- Coming soon: Writes a row to the
Script Outputsheet if it did anything (sent emails, validated things, etc.)
In practice, this means that the admin list (Seth, Teo, and others if we deem appropriate) will receive an email one day before the "real" email list is sent out, and it'll mark the Admin email sent column as Yes in the spreadsheet. We'll review this and make changes if there are any issues (spelling mistakes, etc.).
Given that the Process sheet has dates on Monday, the beta emails will be sent on Sunday night (technically early Monday morning), and the real emails on Monday night. It also means that if the prerequisite cells aren't filled out on the spreadsheet, it'll skip sending the emails for that night, and everything will be pushed to the next day (beta email will be sent first, then real email).
The following steps are used to set up a fresh EC2 server. Don't use this section if you're a new contributor!
# On laptop - move over PEM file and secrets folder and ssh into server
IP=0.0.0.0 # get this from Teo prior to executing these steps (look on Discord)
scp -r -i /path/to/phone_buddy_key_pair.pem /path/to/secrets ec2-user@$IP:/home/ec2-user/aesop-afghanistan
ssh -i /path/to/phone_buddy_key_pair.pem ec2-user@$IP
# On server - install updates, tools, and download code
sudo yum update -y && sudo yum install git tmux docker emacs-nox cronie -y
tmux
sudo systemctl enable crond
sudo systemctl start crond
sudo systemctl start docker
sudo usermod -aG docker ec2-user
# Reconnect to the server to allow the changes to take affect
# Install code and Teo's dotfiles
cd ~
git clone https://github.com/mokolodi1/aesop-afghanistan
git clone https://github.com/mokolodi1/dotfiles
cd dotfiles
./install.sh
# Note: might want to restart tmux in order to pull latest configuration file
Set up cron as follows with crontab -e:
0 9 * * * { echo "[$(date +\%Y-\%m-\%d\ \%H:\%M:\%S)] Starting job"; /usr/bin/docker run -it --rm -v /home/ec2-user/aesop-afghanistan:/app aesop-phone-buddy-script python phonebuddies/email_phone_buddies.py --send-emails --robot; echo "[$(date +\%Y-\%m-\%d\ \%H:\%M:\%S)] Job completed"; } >> /home/ec2-user/aesop-afghanistan/cron_logs.txt 2>&1
If the tmux session is not set up as you're used to, check out this cheat sheet: https://tmuxcheatsheet.com/
Example of use:
laptop$ IP=0.0.0.0 # get this and the .pem file from Teo prior to executing these steps
laptop$ ssh -i /path/to/phone_buddy_key_pair.pem ec2-user@$IP
server$ tmux a # attach to running tmux session
server$ cd ~/aesop-afghanistan/
server$ rm token.json # if the token file has expired
server$ /usr/bin/docker run -it --rm -v /home/ec2-user/aesop-afghanistan:/app aesop-phone-buddy-script
If you get a scary-looking file permissions error, run the following:
chmod 400 /path/to/phone_buddy_key_pair.pem
As of January 2024, we're having weekly meetings to check in on development and move this project along. If you're interested in helping out, send Teo a WhatsApp at +33 6 17 50 71 28.
This video walks you through setting up from scratch: https://www.loom.com/share/94f6a709d71843abbad769c87861cd80
Teo will add you to the spreadsheet and appropriate documents. Bug him if he doesn't reach out and let you know where to look!
git clone https://github.com/mokolodi1/aesop-afghanistan
cd aesop-afghanistan
Ensure that Docker is installed on your local machine. If you don't have Docker installed, you can follow the installation instructions for your specific operating system on the official Docker website: Docker Installation Guide.
You can get yourself into an environment where you can test the script using the following commands.
docker build -t aesop-phone-buddy-script . && docker run -it --rm -v "$(pwd)":/app aesop-phone-buddy-scriptYou will be dropped into a Docker shell session where you can run commands in Python on the code that's on your filesystem.
You'll need to set up several files locally in order to successfully run the script. Ask another team member to provide these files for you.
In the secrets folder, you'll need:
credentials.json: Google Auth credentials file (can be downloaded from Teo's Google account here).admin_emails.txt: A list of emails to be notified of issues/errors by the script. (Looks like:email1@example.com,email2@example.com)spreadsheet_id.txt: Contains the Google Sheets document ID. (Looks like1LM8lzRMn9L5uwTWyes6tGfYiIiBFUxWIzQDFrbceDTA.)
This can be run in interactive mode in Docker to discover all the tests and run them:
python -m unittest discover
Some examples of what you can run when running in intefactive mode in Docker:
# Test the script without sending any emails
python phonebuddies/email_phone_buddies.py
# Test the script without the user prompts (this is how it will run on the server)
python phonebuddies/email_phone_buddies.py --robot
# Actually send emails (use with caution!)
python phonebuddies/email_phone_buddies.py --send-emails
You can create a new branch for your contributions. For example:
git checkout -b feature/new-featureMake the necessary changes to the codebase, documentation, or other project files.
git commit -m "Your commit message here."You can push your branch to your forked repository on GitHub:
git push origin feature/new-featureAfter making changes and ensuring that the tests pass, open a pull request from your branch to the main repository's main branch. You can provide the description of your changes and reference any related issues or pull requests.