Skip to content

🦉 A minimalist python API for interacting with the quill registration tool

License

Notifications You must be signed in to change notification settings

hack-rice/feather

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

feather

IN DEVELOPMENT: a minimalist python API for interacting with the quill registration tool

Build Status codecov

Quill is amazing. But it wasn't built for HackRice, and there are features we need that it just doesn't provide. Enter Feather.

We use Feather to streamline our application evaluation process, conduct email campaigns, and much more. See below for more details.

API

More thorough documentation is in development. For now, go through the code.

Scripts

How to Get Started

This will cover how to run the scripts available in the package. First, go into the scripts directory and copy-and-paste example.env into a .env file. Change the variables as necessary to configure your project.

Then, set up the environment and install dependencies.

# start in the feather/ directory
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt

evaluate_applicants.py

This script will let you accept, reject, and waitlist applicants by uploading a csv with necessary information on each applicant.

python3 -m scripts.evaluate_applicants

load_applicants.py

This script will load a csv with necessary information on submitted users whose applications haven't been evaluated yet.

python3 -m scripts.load_applicants

send_reminders.py

This script will send emails to all of the registered users who haven't completed their application.

python3 -m scripts.send_reminders

Tests

Set up the environment and install dependencies.

# start in the feather/ directory
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt

Then, you can run tests with python3 -m unittest.