Minichore

This is a Django site for allocating chores among household members using a simple, brute-force minimax algorithm. Each household member gets to say how much each chore is "worth" to him or her, and then we minimize the total work done by each person according to their own weightings.

For instance, maybe Bob thinks laundry is 60% of the work and dishes are 40% of the work, and Joe thinks that dishes are 60% while laundry is 40%. Clearly, Bob should do the dishes and Joe should do the laundry - they'll each feel like they're getting the better deal! But as the number of chores and/or household members grows, it gets trickier to optimize without a lot of horse-trading. That's where minichore comes in.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Install pyenv (see https://github.com/yyuu/pyenv)
Install virtualenv [sudo] pip install virtualenv
Install python 3.6.4 or higher via pyenv, e.g.: pyenv install 3.6.4

Installing

Clone this repo. (You can fork it to keep track of your own changes on github if you want, and submit PRs back here.)
Create a virtual environment (from the main minichore directory, or wherever else is convenient for you): virtualenv -p ~/.pyenv/versions/3.6.4/bin/python3.6 venv
Enter the virtual environment source venv/bin/activate
Install requirements: pip install -r requirements.txt
Now you should be able to run it locally using manage.py!

    python manage.py makemigrations
    python manage.py migrate
    python manage.py runserver

After installation, you can run the server just by entering the virtual environment and using manage.py runserver.

Running the tests

There are no tests yet! Sorry.

Deployment

See https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django/Deployment

Contributing

Contributions are welcome! This is a project I started in order to learn to use Django and any strange code you encounter likely reflects inexperience; please feel free to clean things up as you add...

To do

Allow the 'target' amount of work to vary per household member, instead of assuming an even split is desired - e.g., for families with children, couples who agree a stay-at-home parent should do >50% of housework, coworkers with different roles. Right now this would be done clumsily by assigning some placeholder task to people expected to do less.
Provide an optional allocation detail view that lists each person's chores, instead of a table, for accessibility/convenience.
Add user authentication so that users can be associated with households, enter and view their own weights, etc.

kimberscott/minichore