<commit_before>
Start by trying out the demo here: http://live.goodenergy.ca

Good Energy is a behavior change and employee engagement tool. It uses key results from social psychology research (social norms, pledges, identity) to assist individuals in achieving their goals. It has been deployed in production with the David Suzuki Foundation, focused on environmental sustainability, and with a Vancouver area school, focused on student self-improvement.

Good Energy was designed as a white-label product. The company purchasing it brands the header, footer, and CSS to look like their site. It then looks integrated into either a company Intranet, or a public Internet.

The questions you get asked (top center), as well as the default Pledges (bottom right) are configurable via the django admin interface.

WARNING: Good Energy is currently [abandon-ware](http://en.wikipedia.org/wiki/Abandonware). You could probably hire the original developers (see http://goodenergy.ca) to assist in a deployment, and with behavior change consulting, but there's no offical support for it, and we're both pretty busy.

You should have at least basic Django, Unix, and database skills before trying to set up this app. As long as you understand that, and you need a behavior change / employee engagement tool, we think you'll really like Good Energy.

Good Energy is free software, licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl.html).

# Installation

### Get Dependencies:

The obvious stuff:
    - Python 2.6+
    - Django 1.3+ 
    - A Django supported database. Tested with MySQL and Postgres.
    - Memcached and it's python lib (See: http://docs.djangoproject.com/en/dev/topics/cache/#memcached). Memcached is not optional.

Python libs:
    - pytz: http://pytz.sourceforge.net/ (Ubuntu package: **python-tz**)
    - Python Imaging Library (PIL): http://effbot.org/zone/pil-index.htm (Ubuntu package: **python-imaging**)

Django apps:
    - sorl.thumbnail: http://thumbnail.sorl.net/ (**pip install sorl-thumbnail**)
    - django-compress: http://code.google.com/p/django-compress/ (Checkout source and _python setup.py install_)

For the back-end worker (optional):
    - Gearman: http://gearman.org/ (Ubuntu package: **gearman-job-server**)
    - python-libgearman: http://pypi.python.org/pypi/python-libgearman/ (Ubuntu package: **python-gearman.libgearman**)
    - oilcan: http://github.com/grahamking/oilcan (See README at that url)

### Generate SECRET_KEY.

Run this command:

    python -c 'import random; print "".join([random.choice("abcdefghijklmnopqrstuvwxyz123456790!@#$%^&*(-_=+)") for i in range(50)])'
<commit_msg>Formatting README<commit_after>
Start by trying out the demo here: http://live.goodenergy.ca

Good Energy is a behavior change and employee engagement tool. It uses key results from social psychology research (social norms, pledges, identity) to assist individuals in achieving their goals. It has been deployed in production with the David Suzuki Foundation, focused on environmental sustainability, and with a Vancouver area school, focused on student self-improvement.

Good Energy was designed as a white-label product. The company purchasing it brands the header, footer, and CSS to look like their site. It then looks integrated into either a company Intranet, or a public Internet.

The questions you get asked (top center), as well as the default Pledges (bottom right) are configurable via the django admin interface.

WARNING: Good Energy is currently [abandon-ware](http://en.wikipedia.org/wiki/Abandonware). You could probably hire the original developers (see http://goodenergy.ca) to assist in a deployment, and with behavior change consulting, but there's no offical support for it, and we're both pretty busy.

You should have at least basic Django, Unix, and database skills before trying to set up this app. As long as you understand that, and you need a behavior change / employee engagement tool, we think you'll really like Good Energy.

Good Energy is free software, licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl.html).

# Installation

### Get Dependencies:

The obvious stuff:

  - Python 2.6+
  - Django 1.3+ 
  - A Django supported database. Tested with MySQL and Postgres.
  - Memcached and it's python lib (See: http://docs.djangoproject.com/en/dev/topics/cache/#memcached). Memcached is not optional.

Python libs:

  - pytz: http://pytz.sourceforge.net/ (Ubuntu package: **python-tz**)
  - Python Imaging Library (PIL): http://effbot.org/zone/pil-index.htm (Ubuntu package: **python-imaging**)

Django apps:

  - sorl.thumbnail: http://thumbnail.sorl.net/ (**pip install sorl-thumbnail**)
  - django-compress: http://code.google.com/p/django-compress/ (Checkout source and _python setup.py install_)

For the back-end worker (optional):

  - Gearman: http://gearman.org/ (Ubuntu package: **gearman-job-server**)
  - python-libgearman: http://pypi.python.org/pypi/python-libgearman/ (Ubuntu package: **python-gearman.libgearman**)
  - oilcan: http://github.com/grahamking/oilcan (See README at that url)

### Generate SECRET_KEY.

Run this command:

    python -c 'import random; print "".join([random.choice("abcdefghijklmnopqrstuvwxyz123456790!@#$%^&*(-_=+)") for i in range(50)])'

{'fraction_non_alphanumeric': 0.10142749812171299, 'fraction_numerical': 0.005634861006761833, 'mean_word_length': 4.325, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6451182', 'n_tokens_mistral': 1596, 'n_tokens_neox': 1469, 'n_words': 617}