biolab/rawzica

Name: rawzica

Owner: Bioinformatics Laboratory

Description: Chores reminders for workplaces

Created: 2015-12-18 13:54:36.0

Updated: 2016-02-01 14:43:26.0

Pushed: 2017-03-17 10:34:17.0

Homepage: null

Size: 11

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

rawzica - Chores reminders for workplaces

So you have plants at your workplace. Perhaps you hold common meals on fridays and there's dishes to be cleaned, remains to be stuffed with. Maybe you lack a cleaning lady, and one of you has to do all the work. Every time.

Perhaps you decide to take turns in waterning the plants, cleaning the shit up, and taking care of similar chores. Perhaps you shift duties every other week, keeping the chiefs in an online collaborative spreadsheet.

Rawzica can parse that (CSV) spreadsheet and send configurable daily email reminders.

Installing

To install on a POSIX-compatible system:

 pip install git+https://github.com/biolab/rawzica.git

If your /etc/crontab doesn't already periodically (i.e. daily) invoke the scripts in /etc/cron.daily/ (as is probably the case in Mac OS X), you may need to set it so that it does.

Usage

Configure rawzica in /etc/rawzica.conf. That's it.

Example

Say you have a direct URL to a CSV spreadsheet (Google Sheets work well if you use the export/download URL) in the following format:

t date,name,email,chore
-12-10  ,Ann,a@acme.com,wash the dishes
-12-24 ,Bill,b@acme.com,sit on the couch all day long
-01-08,Cindy,c@acme.com,bring male coworkers beer
-01-22 ,Dave,d@acme.com,make up more shit for Ann to do

Basically, the spreadsheet is populated with chores you and your coworkers agree upon. The start date field and the email field are mandatory, although they may be called otherwise, others are optional, dependent on the email template you use.

Say also you have the following email.template, which adheres to Python's str.format() specification:

 {name}!

s it going, {name}?

 your turn this week to {chore}.

y it, {name}.

 beloved coworkers,

Now, you can configure rawzica with the following /etc/rawzica.conf file:

ault]
= https://docs.google.com/spreadsheets/d/Your_GDocs_Sheet_Key/export?format=csv&gid=0
_format = %Y-%m-%d

_fields]
t_date = start date
_to = email

p]
 = insecure-smtp.acme.com
_from = rawzica@acme.com

plate]
ay = /path/to/rawzica/template/email.template
ay_subject = rawzica chore notification

In the above case, email notifications will be sent out only on mondays. You can have different notifications for different days of the week. See the configuration file for more information.

If it's Monday, you can test the setup by running on the command line:

ica

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.